From ee4d301d22466b8ce252ffeb7b1ca7943f504864 Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Mon, 22 Sep 2025 16:26:01 -0400 Subject: [PATCH 1/6] Update listApis with 4.21 APIs --- cloudstack/AccountService.go | 120 + cloudstack/AddressService.go | 29 + cloudstack/AffinityGroupService.go | 12 + cloudstack/AsyncjobService.go | 70 +- cloudstack/AuthenticationService.go | 74 +- cloudstack/ClusterService.go | 287 +- cloudstack/ConfigurationService.go | 5 + cloudstack/DomainService.go | 75 + cloudstack/EventService.go | 24 + cloudstack/GuestOSService.go | 183 +- cloudstack/HostService.go | 340 + cloudstack/ISOService.go | 85 + cloudstack/KubernetesService.go | 259 + cloudstack/LDAPService.go | 15 + cloudstack/ManagementService.go | 79 +- cloudstack/ManagementService_mock.go | 8 +- cloudstack/NetworkOfferingService.go | 24 + cloudstack/NetworkService.go | 2 +- cloudstack/NicService.go | 12 + cloudstack/ObjectStoreService.go | 5 +- cloudstack/ObjectStoreService_mock.go | 8 +- cloudstack/PodService.go | 185 +- cloudstack/PoolService.go | 58 + cloudstack/ProjectService.go | 75 + cloudstack/QuotaService.go | 13 +- cloudstack/SSHService.go | 12 + cloudstack/ServiceOfferingService.go | 264 + cloudstack/SnapshotService.go | 171 + cloudstack/StoragePoolService.go | 137 +- cloudstack/TemplateService.go | 294 + cloudstack/UserService.go | 26 +- cloudstack/VLANService.go | 55 +- cloudstack/VPCService.go | 162 +- cloudstack/VPCService_mock.go | 8 +- cloudstack/VPNService.go | 24 + cloudstack/VirtualMachineService.go | 607 +- cloudstack/VirtualMachineService_mock.go | 8 +- cloudstack/VirtualNetworkFunctionsService.go | 490 +- .../VirtualNetworkFunctionsService_mock.go | 8 +- cloudstack/ZoneService.go | 89 + generate/generate.go | 8 + generate/listApis.json | 157709 ++++++++------- test/ManagementService_test.go | 2 +- test/ObjectStoreService_test.go | 2 +- test/VPCService_test.go | 2 +- test/VirtualMachineService_test.go | 2 +- test/VirtualNetworkFunctionsService_test.go | 2 +- 47 files changed, 89396 insertions(+), 72733 deletions(-) diff --git a/cloudstack/AccountService.go b/cloudstack/AccountService.go index 189aa3a6..be336787 100644 --- a/cloudstack/AccountService.go +++ b/cloudstack/AccountService.go @@ -444,6 +444,15 @@ type CreateAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` Apikeyaccess string `json:"apikeyaccess"` + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -452,6 +461,9 @@ type CreateAccountResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Groups []string `json:"groups"` Icon interface{} `json:"icon"` Id string `json:"id"` @@ -470,6 +482,9 @@ type CreateAccountResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` Primarystoragetotal int64 `json:"primarystoragetotal"` @@ -773,6 +788,15 @@ type DisableAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` Apikeyaccess string `json:"apikeyaccess"` + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -781,6 +805,9 @@ type DisableAccountResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Groups []string `json:"groups"` Icon interface{} `json:"icon"` Id string `json:"id"` @@ -799,6 +826,9 @@ type DisableAccountResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` Primarystoragetotal int64 `json:"primarystoragetotal"` @@ -974,6 +1004,15 @@ type EnableAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` Apikeyaccess string `json:"apikeyaccess"` + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -982,6 +1021,9 @@ type EnableAccountResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Groups []string `json:"groups"` Icon interface{} `json:"icon"` Id string `json:"id"` @@ -1000,6 +1042,9 @@ type EnableAccountResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` Primarystoragetotal int64 `json:"primarystoragetotal"` @@ -1843,6 +1888,15 @@ type Account struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` Apikeyaccess string `json:"apikeyaccess"` + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -1851,6 +1905,9 @@ type Account struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Groups []string `json:"groups"` Icon interface{} `json:"icon"` Id string `json:"id"` @@ -1869,6 +1926,9 @@ type Account struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` Primarystoragetotal int64 `json:"primarystoragetotal"` @@ -2206,6 +2266,15 @@ type ListProjectAccountsResponse struct { } type ProjectAccount struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2213,6 +2282,9 @@ type ProjectAccount struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Icon interface{} `json:"icon"` Id string `json:"id"` Ipavailable string `json:"ipavailable"` @@ -2227,6 +2299,9 @@ type ProjectAccount struct { Networkavailable string `json:"networkavailable"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Owner []map[string]string `json:"owner"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` @@ -2360,6 +2435,15 @@ type LockAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` Apikeyaccess string `json:"apikeyaccess"` + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2368,6 +2452,9 @@ type LockAccountResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Groups []string `json:"groups"` Icon interface{} `json:"icon"` Id string `json:"id"` @@ -2386,6 +2473,9 @@ type LockAccountResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` Primarystoragetotal int64 `json:"primarystoragetotal"` @@ -2584,6 +2674,15 @@ type MarkDefaultZoneForAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` Apikeyaccess string `json:"apikeyaccess"` + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2592,6 +2691,9 @@ type MarkDefaultZoneForAccountResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Groups []string `json:"groups"` Icon interface{} `json:"icon"` Id string `json:"id"` @@ -2610,6 +2712,9 @@ type MarkDefaultZoneForAccountResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` Primarystoragetotal int64 `json:"primarystoragetotal"` @@ -2908,6 +3013,15 @@ type UpdateAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` Apikeyaccess string `json:"apikeyaccess"` + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2916,6 +3030,9 @@ type UpdateAccountResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Groups []string `json:"groups"` Icon interface{} `json:"icon"` Id string `json:"id"` @@ -2934,6 +3051,9 @@ type UpdateAccountResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` Primarystoragetotal int64 `json:"primarystoragetotal"` diff --git a/cloudstack/AddressService.go b/cloudstack/AddressService.go index c17297b7..98ce3aa8 100644 --- a/cloudstack/AddressService.go +++ b/cloudstack/AddressService.go @@ -450,6 +450,7 @@ type AssociateIpAddressResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` + Forprovider bool `json:"forprovider"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Hasannotations bool `json:"hasannotations"` @@ -619,6 +620,10 @@ func (p *ListPublicIpAddressesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("forloadbalancing", vv) } + if v, found := p.p["forprovider"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forprovider", vv) + } if v, found := p.p["forsystemvms"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forsystemvms", vv) @@ -821,6 +826,27 @@ func (p *ListPublicIpAddressesParams) GetForloadbalancing() (bool, bool) { return value, ok } +func (p *ListPublicIpAddressesParams) SetForprovider(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forprovider"] = v +} + +func (p *ListPublicIpAddressesParams) ResetForprovider() { + if p.p != nil && p.p["forprovider"] != nil { + delete(p.p, "forprovider") + } +} + +func (p *ListPublicIpAddressesParams) GetForprovider() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forprovider"].(bool) + return value, ok +} + func (p *ListPublicIpAddressesParams) SetForsystemvms(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1311,6 +1337,7 @@ type PublicIpAddress struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` + Forprovider bool `json:"forprovider"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Hasannotations bool `json:"hasannotations"` @@ -1482,6 +1509,7 @@ type UpdateIpAddressResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` + Forprovider bool `json:"forprovider"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Hasannotations bool `json:"hasannotations"` @@ -1870,6 +1898,7 @@ type ReserveIpAddressResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` + Forprovider bool `json:"forprovider"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Hasannotations bool `json:"hasannotations"` diff --git a/cloudstack/AffinityGroupService.go b/cloudstack/AffinityGroupService.go index 04dcc7a2..afd1767e 100644 --- a/cloudstack/AffinityGroupService.go +++ b/cloudstack/AffinityGroupService.go @@ -1156,6 +1156,9 @@ type UpdateVMAffinityGroupResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -1177,6 +1180,12 @@ type UpdateVMAffinityGroupResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -1218,6 +1227,9 @@ type UpdateVMAffinityGroupResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` diff --git a/cloudstack/AsyncjobService.go b/cloudstack/AsyncjobService.go index 826b1e92..fe29bc43 100644 --- a/cloudstack/AsyncjobService.go +++ b/cloudstack/AsyncjobService.go @@ -294,23 +294,24 @@ type ListAsyncJobsResponse struct { } type AsyncJob struct { - Account string `json:"account"` - Accountid string `json:"accountid"` - Cmd string `json:"cmd"` - Completed string `json:"completed"` - Created string `json:"created"` - Domainid string `json:"domainid"` - Domainpath string `json:"domainpath"` - JobID string `json:"jobid"` - Jobinstanceid string `json:"jobinstanceid"` - Jobinstancetype string `json:"jobinstancetype"` - Jobprocstatus int `json:"jobprocstatus"` - Jobresult json.RawMessage `json:"jobresult"` - Jobresultcode int `json:"jobresultcode"` - Jobresulttype string `json:"jobresulttype"` - Jobstatus int `json:"jobstatus"` - Managementserverid UUID `json:"managementserverid"` - Userid string `json:"userid"` + Account string `json:"account"` + Accountid string `json:"accountid"` + Cmd string `json:"cmd"` + Completed string `json:"completed"` + Created string `json:"created"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + JobID string `json:"jobid"` + Jobinstanceid string `json:"jobinstanceid"` + Jobinstancetype string `json:"jobinstancetype"` + Jobprocstatus int `json:"jobprocstatus"` + Jobresult json.RawMessage `json:"jobresult"` + Jobresultcode int `json:"jobresultcode"` + Jobresulttype string `json:"jobresulttype"` + Jobstatus int `json:"jobstatus"` + Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` + Userid string `json:"userid"` } type QueryAsyncJobResultParams struct { @@ -384,21 +385,22 @@ func (s *AsyncjobService) QueryAsyncJobResult(p *QueryAsyncJobResultParams) (*Qu } type QueryAsyncJobResultResponse struct { - Account string `json:"account"` - Accountid string `json:"accountid"` - Cmd string `json:"cmd"` - Completed string `json:"completed"` - Created string `json:"created"` - Domainid string `json:"domainid"` - Domainpath string `json:"domainpath"` - JobID string `json:"jobid"` - Jobinstanceid string `json:"jobinstanceid"` - Jobinstancetype string `json:"jobinstancetype"` - Jobprocstatus int `json:"jobprocstatus"` - Jobresult json.RawMessage `json:"jobresult"` - Jobresultcode int `json:"jobresultcode"` - Jobresulttype string `json:"jobresulttype"` - Jobstatus int `json:"jobstatus"` - Managementserverid UUID `json:"managementserverid"` - Userid string `json:"userid"` + Account string `json:"account"` + Accountid string `json:"accountid"` + Cmd string `json:"cmd"` + Completed string `json:"completed"` + Created string `json:"created"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + JobID string `json:"jobid"` + Jobinstanceid string `json:"jobinstanceid"` + Jobinstancetype string `json:"jobinstancetype"` + Jobprocstatus int `json:"jobprocstatus"` + Jobresult json.RawMessage `json:"jobresult"` + Jobresultcode int `json:"jobresultcode"` + Jobresulttype string `json:"jobresulttype"` + Jobstatus int `json:"jobstatus"` + Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` + Userid string `json:"userid"` } diff --git a/cloudstack/AuthenticationService.go b/cloudstack/AuthenticationService.go index be0d3a6c..bf12f55c 100644 --- a/cloudstack/AuthenticationService.go +++ b/cloudstack/AuthenticationService.go @@ -169,24 +169,25 @@ func (s *AuthenticationService) Login(p *LoginParams) (*LoginResponse, error) { } type LoginResponse struct { - Account string `json:"account"` - Domainid string `json:"domainid"` - Firstname string `json:"firstname"` - Is2faenabled string `json:"is2faenabled"` - Is2faverified string `json:"is2faverified"` - Issuerfor2fa string `json:"issuerfor2fa"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Lastname string `json:"lastname"` - Providerfor2fa string `json:"providerfor2fa"` - Registered string `json:"registered"` - Sessionkey string `json:"sessionkey"` - Timeout int `json:"timeout"` - Timezone string `json:"timezone"` - Timezoneoffset string `json:"timezoneoffset"` - Type string `json:"type"` - Userid string `json:"userid"` - Username string `json:"username"` + Account string `json:"account"` + Domainid string `json:"domainid"` + Firstname string `json:"firstname"` + Is2faenabled string `json:"is2faenabled"` + Is2faverified string `json:"is2faverified"` + Issuerfor2fa string `json:"issuerfor2fa"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lastname string `json:"lastname"` + Managementserverid UUID `json:"managementserverid"` + Providerfor2fa string `json:"providerfor2fa"` + Registered string `json:"registered"` + Sessionkey string `json:"sessionkey"` + Timeout int `json:"timeout"` + Timezone string `json:"timezone"` + Timezoneoffset string `json:"timezoneoffset"` + Type string `json:"type"` + Userid string `json:"userid"` + Username string `json:"username"` } type LogoutParams struct { @@ -389,22 +390,23 @@ func (s *AuthenticationService) Oauthlogin(p *OauthloginParams) (*OauthloginResp } type OauthloginResponse struct { - Account string `json:"account"` - Domainid string `json:"domainid"` - Firstname string `json:"firstname"` - Is2faenabled string `json:"is2faenabled"` - Is2faverified string `json:"is2faverified"` - Issuerfor2fa string `json:"issuerfor2fa"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Lastname string `json:"lastname"` - Providerfor2fa string `json:"providerfor2fa"` - Registered string `json:"registered"` - Sessionkey string `json:"sessionkey"` - Timeout int `json:"timeout"` - Timezone string `json:"timezone"` - Timezoneoffset string `json:"timezoneoffset"` - Type string `json:"type"` - Userid string `json:"userid"` - Username string `json:"username"` + Account string `json:"account"` + Domainid string `json:"domainid"` + Firstname string `json:"firstname"` + Is2faenabled string `json:"is2faenabled"` + Is2faverified string `json:"is2faverified"` + Issuerfor2fa string `json:"issuerfor2fa"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lastname string `json:"lastname"` + Managementserverid UUID `json:"managementserverid"` + Providerfor2fa string `json:"providerfor2fa"` + Registered string `json:"registered"` + Sessionkey string `json:"sessionkey"` + Timeout int `json:"timeout"` + Timezone string `json:"timezone"` + Timezoneoffset string `json:"timezoneoffset"` + Type string `json:"type"` + Userid string `json:"userid"` + Username string `json:"username"` } diff --git a/cloudstack/ClusterService.go b/cloudstack/ClusterService.go index 46843825..1e10470b 100644 --- a/cloudstack/ClusterService.go +++ b/cloudstack/ClusterService.go @@ -88,6 +88,16 @@ func (p *AddClusterParams) toURLValues() url.Values { if v, found := p.p["clustertype"]; found { u.Set("clustertype", v.(string)) } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } if v, found := p.p["guestvswitchname"]; found { u.Set("guestvswitchname", v.(string)) } @@ -118,6 +128,10 @@ func (p *AddClusterParams) toURLValues() url.Values { if v, found := p.p["publicvswitchtype"]; found { u.Set("publicvswitchtype", v.(string)) } + if v, found := p.p["storageaccessgroups"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("storageaccessgroups", vv) + } if v, found := p.p["url"]; found { u.Set("url", v.(string)) } @@ -223,6 +237,48 @@ func (p *AddClusterParams) GetClustertype() (string, bool) { return value, ok } +func (p *AddClusterParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *AddClusterParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *AddClusterParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *AddClusterParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *AddClusterParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *AddClusterParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + func (p *AddClusterParams) SetGuestvswitchname(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -433,6 +489,27 @@ func (p *AddClusterParams) GetPublicvswitchtype() (string, bool) { return value, ok } +func (p *AddClusterParams) SetStorageaccessgroups(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroups"] = v +} + +func (p *AddClusterParams) ResetStorageaccessgroups() { + if p.p != nil && p.p["storageaccessgroups"] != nil { + delete(p.p, "storageaccessgroups") + } +} + +func (p *AddClusterParams) GetStorageaccessgroups() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroups"].([]string) + return value, ok +} + func (p *AddClusterParams) SetUrl(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -592,25 +669,30 @@ func (s *ClusterService) AddCluster(p *AddClusterParams) (*AddClusterResponse, e } type AddClusterResponse struct { - Allocationstate string `json:"allocationstate"` - Arch string `json:"arch"` - Capacity []AddClusterResponseCapacity `json:"capacity"` - Clustertype string `json:"clustertype"` - Cpuovercommitratio string `json:"cpuovercommitratio"` - Hasannotations bool `json:"hasannotations"` - Hypervisortype string `json:"hypervisortype"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Managedstate string `json:"managedstate"` - Memoryovercommitratio string `json:"memoryovercommitratio"` - Name string `json:"name"` - Ovm3vip string `json:"ovm3vip"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Resourcedetails map[string]string `json:"resourcedetails"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Allocationstate string `json:"allocationstate"` + Arch string `json:"arch"` + Capacity []AddClusterResponseCapacity `json:"capacity"` + Clustertype string `json:"clustertype"` + Cpuovercommitratio string `json:"cpuovercommitratio"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Hasannotations bool `json:"hasannotations"` + Hypervisortype string `json:"hypervisortype"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Managedstate string `json:"managedstate"` + Memoryovercommitratio string `json:"memoryovercommitratio"` + Name string `json:"name"` + Ovm3vip string `json:"ovm3vip"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` + Resourcedetails map[string]string `json:"resourcedetails"` + Storageaccessgroups string `json:"storageaccessgroups"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type AddClusterResponseCapacity struct { @@ -1482,6 +1564,9 @@ func (p *ListClustersParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("showcapacities", vv) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -1740,6 +1825,27 @@ func (p *ListClustersParams) GetShowcapacities() (bool, bool) { return value, ok } +func (p *ListClustersParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListClustersParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListClustersParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListClustersParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1873,25 +1979,30 @@ type ListClustersResponse struct { } type Cluster struct { - Allocationstate string `json:"allocationstate"` - Arch string `json:"arch"` - Capacity []ClusterCapacity `json:"capacity"` - Clustertype string `json:"clustertype"` - Cpuovercommitratio string `json:"cpuovercommitratio"` - Hasannotations bool `json:"hasannotations"` - Hypervisortype string `json:"hypervisortype"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Managedstate string `json:"managedstate"` - Memoryovercommitratio string `json:"memoryovercommitratio"` - Name string `json:"name"` - Ovm3vip string `json:"ovm3vip"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Resourcedetails map[string]string `json:"resourcedetails"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Allocationstate string `json:"allocationstate"` + Arch string `json:"arch"` + Capacity []ClusterCapacity `json:"capacity"` + Clustertype string `json:"clustertype"` + Cpuovercommitratio string `json:"cpuovercommitratio"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Hasannotations bool `json:"hasannotations"` + Hypervisortype string `json:"hypervisortype"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Managedstate string `json:"managedstate"` + Memoryovercommitratio string `json:"memoryovercommitratio"` + Name string `json:"name"` + Ovm3vip string `json:"ovm3vip"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` + Resourcedetails map[string]string `json:"resourcedetails"` + Storageaccessgroups string `json:"storageaccessgroups"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type ClusterCapacity struct { @@ -2164,6 +2275,9 @@ func (p *ListClustersMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("showcapacities", vv) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -2422,6 +2536,27 @@ func (p *ListClustersMetricsParams) GetShowcapacities() (bool, bool) { return value, ok } +func (p *ListClustersMetricsParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListClustersMetricsParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListClustersMetricsParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListClustersMetricsParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2569,6 +2704,8 @@ type ClustersMetric struct { Cputotal string `json:"cputotal"` Cpuused string `json:"cpuused"` Drsimbalance string `json:"drsimbalance"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Hasannotations bool `json:"hasannotations"` Hosts string `json:"hosts"` Hypervisortype string `json:"hypervisortype"` @@ -2589,10 +2726,13 @@ type ClustersMetric struct { Ovm3vip string `json:"ovm3vip"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Resourcedetails map[string]string `json:"resourcedetails"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type ClustersMetricCapacity struct { @@ -2935,6 +3075,13 @@ func (p *UpdateClusterParams) toURLValues() url.Values { if v, found := p.p["clustertype"]; found { u.Set("clustertype", v.(string)) } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } @@ -3031,6 +3178,27 @@ func (p *UpdateClusterParams) GetClustertype() (string, bool) { return value, ok } +func (p *UpdateClusterParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *UpdateClusterParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *UpdateClusterParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + func (p *UpdateClusterParams) SetHypervisor(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3123,25 +3291,30 @@ func (s *ClusterService) UpdateCluster(p *UpdateClusterParams) (*UpdateClusterRe } type UpdateClusterResponse struct { - Allocationstate string `json:"allocationstate"` - Arch string `json:"arch"` - Capacity []UpdateClusterResponseCapacity `json:"capacity"` - Clustertype string `json:"clustertype"` - Cpuovercommitratio string `json:"cpuovercommitratio"` - Hasannotations bool `json:"hasannotations"` - Hypervisortype string `json:"hypervisortype"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Managedstate string `json:"managedstate"` - Memoryovercommitratio string `json:"memoryovercommitratio"` - Name string `json:"name"` - Ovm3vip string `json:"ovm3vip"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Resourcedetails map[string]string `json:"resourcedetails"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Allocationstate string `json:"allocationstate"` + Arch string `json:"arch"` + Capacity []UpdateClusterResponseCapacity `json:"capacity"` + Clustertype string `json:"clustertype"` + Cpuovercommitratio string `json:"cpuovercommitratio"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Hasannotations bool `json:"hasannotations"` + Hypervisortype string `json:"hypervisortype"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Managedstate string `json:"managedstate"` + Memoryovercommitratio string `json:"memoryovercommitratio"` + Name string `json:"name"` + Ovm3vip string `json:"ovm3vip"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` + Resourcedetails map[string]string `json:"resourcedetails"` + Storageaccessgroups string `json:"storageaccessgroups"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type UpdateClusterResponseCapacity struct { diff --git a/cloudstack/ConfigurationService.go b/cloudstack/ConfigurationService.go index 1978a45a..e5275c06 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -96,6 +96,9 @@ type Capability struct { Customhypervisordisplayname string `json:"customhypervisordisplayname"` Defaultuipagesize int64 `json:"defaultuipagesize"` Dynamicrolesenabled bool `json:"dynamicrolesenabled"` + Dynamicscalingenabled bool `json:"dynamicscalingenabled"` + Extensionspath string `json:"extensionspath"` + Instanceleaseenabled bool `json:"instanceleaseenabled"` Instancesdisksstatsretentionenabled bool `json:"instancesdisksstatsretentionenabled"` Instancesdisksstatsretentiontime int `json:"instancesdisksstatsretentiontime"` Instancesstatsretentiontime int `json:"instancesstatsretentiontime"` @@ -1326,6 +1329,7 @@ type UpdateStorageCapabilitiesResponse struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Disksizeused int64 `json:"disksizeused"` @@ -1346,6 +1350,7 @@ type UpdateStorageCapabilitiesResponse struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storagecapabilities map[string]string `json:"storagecapabilities"` Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` diff --git a/cloudstack/DomainService.go b/cloudstack/DomainService.go index 1433118c..473a2195 100644 --- a/cloudstack/DomainService.go +++ b/cloudstack/DomainService.go @@ -185,11 +185,23 @@ func (s *DomainService) CreateDomain(p *CreateDomainParams) (*CreateDomainRespon } type CreateDomainResponse struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` Created string `json:"created"` Domaindetails map[string]string `json:"domaindetails"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Hasannotations bool `json:"hasannotations"` Haschild bool `json:"haschild"` Icon interface{} `json:"icon"` @@ -208,6 +220,9 @@ type CreateDomainResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Parentdomainid string `json:"parentdomainid"` Parentdomainname string `json:"parentdomainname"` Path string `json:"path"` @@ -667,11 +682,23 @@ type ListDomainChildrenResponse struct { } type DomainChildren struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` Created string `json:"created"` Domaindetails map[string]string `json:"domaindetails"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Hasannotations bool `json:"hasannotations"` Haschild bool `json:"haschild"` Icon interface{} `json:"icon"` @@ -690,6 +717,9 @@ type DomainChildren struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Parentdomainid string `json:"parentdomainid"` Parentdomainname string `json:"parentdomainname"` Path string `json:"path"` @@ -1091,11 +1121,23 @@ type ListDomainsResponse struct { } type Domain struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` Created string `json:"created"` Domaindetails map[string]string `json:"domaindetails"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Hasannotations bool `json:"hasannotations"` Haschild bool `json:"haschild"` Icon interface{} `json:"icon"` @@ -1114,6 +1156,9 @@ type Domain struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Parentdomainid string `json:"parentdomainid"` Parentdomainname string `json:"parentdomainname"` Path string `json:"path"` @@ -1231,11 +1276,23 @@ func (s *DomainService) MoveDomain(p *MoveDomainParams) (*MoveDomainResponse, er } type MoveDomainResponse struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` Created string `json:"created"` Domaindetails map[string]string `json:"domaindetails"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Hasannotations bool `json:"hasannotations"` Haschild bool `json:"haschild"` Icon interface{} `json:"icon"` @@ -1254,6 +1311,9 @@ type MoveDomainResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Parentdomainid string `json:"parentdomainid"` Parentdomainname string `json:"parentdomainname"` Path string `json:"path"` @@ -1398,11 +1458,23 @@ func (s *DomainService) UpdateDomain(p *UpdateDomainParams) (*UpdateDomainRespon } type UpdateDomainResponse struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` Created string `json:"created"` Domaindetails map[string]string `json:"domaindetails"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Hasannotations bool `json:"hasannotations"` Haschild bool `json:"haschild"` Icon interface{} `json:"icon"` @@ -1421,6 +1493,9 @@ type UpdateDomainResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Parentdomainid string `json:"parentdomainid"` Parentdomainname string `json:"parentdomainname"` Path string `json:"path"` diff --git a/cloudstack/EventService.go b/cloudstack/EventService.go index 288edeab..bdf83652 100644 --- a/cloudstack/EventService.go +++ b/cloudstack/EventService.go @@ -487,6 +487,9 @@ func (p *ListEventsParams) toURLValues() url.Values { if v, found := p.p["startid"]; found { u.Set("startid", v.(string)) } + if v, found := p.p["state"]; found { + u.Set("state", v.(string)) + } if v, found := p.p["type"]; found { u.Set("type", v.(string)) } @@ -871,6 +874,27 @@ func (p *ListEventsParams) GetStartid() (string, bool) { return value, ok } +func (p *ListEventsParams) SetState(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["state"] = v +} + +func (p *ListEventsParams) ResetState() { + if p.p != nil && p.p["state"] != nil { + delete(p.p, "state") + } +} + +func (p *ListEventsParams) GetState() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["state"].(string) + return value, ok +} + func (p *ListEventsParams) SetType(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/GuestOSService.go b/cloudstack/GuestOSService.go index a39a5766..f7dd0c03 100644 --- a/cloudstack/GuestOSService.go +++ b/cloudstack/GuestOSService.go @@ -857,9 +857,24 @@ func (p *ListOsCategoriesParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["isfeatured"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isfeatured", vv) + } + if v, found := p.p["isiso"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isiso", vv) + } + if v, found := p.p["isvnf"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isvnf", vv) + } if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } @@ -874,9 +889,37 @@ func (p *ListOsCategoriesParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["showicon"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("showicon", vv) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } return u } +func (p *ListOsCategoriesParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListOsCategoriesParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListOsCategoriesParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListOsCategoriesParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -898,6 +941,69 @@ func (p *ListOsCategoriesParams) GetId() (string, bool) { return value, ok } +func (p *ListOsCategoriesParams) SetIsfeatured(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isfeatured"] = v +} + +func (p *ListOsCategoriesParams) ResetIsfeatured() { + if p.p != nil && p.p["isfeatured"] != nil { + delete(p.p, "isfeatured") + } +} + +func (p *ListOsCategoriesParams) GetIsfeatured() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isfeatured"].(bool) + return value, ok +} + +func (p *ListOsCategoriesParams) SetIsiso(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isiso"] = v +} + +func (p *ListOsCategoriesParams) ResetIsiso() { + if p.p != nil && p.p["isiso"] != nil { + delete(p.p, "isiso") + } +} + +func (p *ListOsCategoriesParams) GetIsiso() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isiso"].(bool) + return value, ok +} + +func (p *ListOsCategoriesParams) SetIsvnf(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isvnf"] = v +} + +func (p *ListOsCategoriesParams) ResetIsvnf() { + if p.p != nil && p.p["isvnf"] != nil { + delete(p.p, "isvnf") + } +} + +func (p *ListOsCategoriesParams) GetIsvnf() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isvnf"].(bool) + return value, ok +} + func (p *ListOsCategoriesParams) SetKeyword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -982,6 +1088,48 @@ func (p *ListOsCategoriesParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListOsCategoriesParams) SetShowicon(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["showicon"] = v +} + +func (p *ListOsCategoriesParams) ResetShowicon() { + if p.p != nil && p.p["showicon"] != nil { + delete(p.p, "showicon") + } +} + +func (p *ListOsCategoriesParams) GetShowicon() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["showicon"].(bool) + return value, ok +} + +func (p *ListOsCategoriesParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListOsCategoriesParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ListOsCategoriesParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + // You should always use this function to get a new ListOsCategoriesParams instance, // as then you are sure you have configured all required params func (s *GuestOSService) NewListOsCategoriesParams() *ListOsCategoriesParams { @@ -1094,10 +1242,13 @@ type ListOsCategoriesResponse struct { } type OsCategory struct { - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` + Created string `json:"created"` + Icon interface{} `json:"icon"` + Id string `json:"id"` + Isfeatured bool `json:"isfeatured"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` } type ListOsTypesParams struct { @@ -1593,6 +1744,9 @@ func (p *UpdateGuestOsParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["oscategoryid"]; found { + u.Set("oscategoryid", v.(string)) + } if v, found := p.p["osdisplayname"]; found { u.Set("osdisplayname", v.(string)) } @@ -1662,6 +1816,27 @@ func (p *UpdateGuestOsParams) GetId() (string, bool) { return value, ok } +func (p *UpdateGuestOsParams) SetOscategoryid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["oscategoryid"] = v +} + +func (p *UpdateGuestOsParams) ResetOscategoryid() { + if p.p != nil && p.p["oscategoryid"] != nil { + delete(p.p, "oscategoryid") + } +} + +func (p *UpdateGuestOsParams) GetOscategoryid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["oscategoryid"].(string) + return value, ok +} + func (p *UpdateGuestOsParams) SetOsdisplayname(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/HostService.go b/cloudstack/HostService.go index d16aed54..78774b23 100644 --- a/cloudstack/HostService.go +++ b/cloudstack/HostService.go @@ -120,6 +120,13 @@ func (p *AddBaremetalHostParams) toURLValues() url.Values { if v, found := p.p["clustername"]; found { u.Set("clustername", v.(string)) } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } if v, found := p.p["hosttags"]; found { vv := strings.Join(v.([]string), ",") u.Set("hosttags", vv) @@ -136,6 +143,10 @@ func (p *AddBaremetalHostParams) toURLValues() url.Values { if v, found := p.p["podid"]; found { u.Set("podid", v.(string)) } + if v, found := p.p["storageaccessgroups"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("storageaccessgroups", vv) + } if v, found := p.p["url"]; found { u.Set("url", v.(string)) } @@ -211,6 +222,27 @@ func (p *AddBaremetalHostParams) GetClustername() (string, bool) { return value, ok } +func (p *AddBaremetalHostParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *AddBaremetalHostParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *AddBaremetalHostParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + func (p *AddBaremetalHostParams) SetHosttags(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -316,6 +348,27 @@ func (p *AddBaremetalHostParams) GetPodid() (string, bool) { return value, ok } +func (p *AddBaremetalHostParams) SetStorageaccessgroups(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroups"] = v +} + +func (p *AddBaremetalHostParams) ResetStorageaccessgroups() { + if p.p != nil && p.p["storageaccessgroups"] != nil { + delete(p.p, "storageaccessgroups") + } +} + +func (p *AddBaremetalHostParams) GetStorageaccessgroups() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroups"].([]string) + return value, ok +} + func (p *AddBaremetalHostParams) SetUrl(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -412,6 +465,7 @@ type AddBaremetalHostResponse struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -431,7 +485,11 @@ type AddBaremetalHostResponse struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []AddBaremetalHostResponseGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -450,6 +508,7 @@ type AddBaremetalHostResponse struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -464,16 +523,20 @@ type AddBaremetalHostResponse struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type AddBaremetalHostResponseGpugroup struct { @@ -667,6 +730,13 @@ func (p *AddHostParams) toURLValues() url.Values { if v, found := p.p["clustername"]; found { u.Set("clustername", v.(string)) } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } if v, found := p.p["hosttags"]; found { vv := strings.Join(v.([]string), ",") u.Set("hosttags", vv) @@ -680,6 +750,10 @@ func (p *AddHostParams) toURLValues() url.Values { if v, found := p.p["podid"]; found { u.Set("podid", v.(string)) } + if v, found := p.p["storageaccessgroups"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("storageaccessgroups", vv) + } if v, found := p.p["url"]; found { u.Set("url", v.(string)) } @@ -755,6 +829,27 @@ func (p *AddHostParams) GetClustername() (string, bool) { return value, ok } +func (p *AddHostParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *AddHostParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *AddHostParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + func (p *AddHostParams) SetHosttags(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -839,6 +934,27 @@ func (p *AddHostParams) GetPodid() (string, bool) { return value, ok } +func (p *AddHostParams) SetStorageaccessgroups(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroups"] = v +} + +func (p *AddHostParams) ResetStorageaccessgroups() { + if p.p != nil && p.p["storageaccessgroups"] != nil { + delete(p.p, "storageaccessgroups") + } +} + +func (p *AddHostParams) GetStorageaccessgroups() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroups"].([]string) + return value, ok +} + func (p *AddHostParams) SetUrl(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -939,6 +1055,7 @@ type AddHostResponse struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -958,7 +1075,11 @@ type AddHostResponse struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []AddHostResponseGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -977,6 +1098,7 @@ type AddHostResponse struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -991,16 +1113,20 @@ type AddHostResponse struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type AddHostResponseGpugroup struct { @@ -1206,6 +1332,7 @@ type CancelHostMaintenanceResponse struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -1225,7 +1352,11 @@ type CancelHostMaintenanceResponse struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []CancelHostMaintenanceResponseGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -1244,6 +1375,7 @@ type CancelHostMaintenanceResponse struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -1258,16 +1390,20 @@ type CancelHostMaintenanceResponse struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type CancelHostMaintenanceResponseGpugroup struct { @@ -2202,6 +2338,7 @@ type HostForMigration struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -2221,7 +2358,11 @@ type HostForMigration struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []HostForMigrationGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -2240,6 +2381,7 @@ type HostForMigration struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -2254,17 +2396,21 @@ type HostForMigration struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` RequiresStorageMotion bool `json:"requiresStorageMotion"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type HostForMigrationGpugroup struct { @@ -2695,6 +2841,9 @@ func (p *ListHostsParams) toURLValues() url.Values { if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } + if v, found := p.p["managementserverid"]; found { + u.Set("managementserverid", v.(string)) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -2722,6 +2871,9 @@ func (p *ListHostsParams) toURLValues() url.Values { if v, found := p.p["state"]; found { u.Set("state", v.(string)) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["type"]; found { u.Set("type", v.(string)) } @@ -2881,6 +3033,27 @@ func (p *ListHostsParams) GetKeyword() (string, bool) { return value, ok } +func (p *ListHostsParams) SetManagementserverid(v UUID) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["managementserverid"] = v +} + +func (p *ListHostsParams) ResetManagementserverid() { + if p.p != nil && p.p["managementserverid"] != nil { + delete(p.p, "managementserverid") + } +} + +func (p *ListHostsParams) GetManagementserverid() (UUID, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["managementserverid"].(UUID) + return value, ok +} + func (p *ListHostsParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3049,6 +3222,27 @@ func (p *ListHostsParams) GetState() (string, bool) { return value, ok } +func (p *ListHostsParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListHostsParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListHostsParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListHostsParams) SetType(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3229,6 +3423,7 @@ type Host struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -3248,7 +3443,11 @@ type Host struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []HostGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -3267,6 +3466,7 @@ type Host struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -3281,16 +3481,20 @@ type Host struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type HostGpugroup struct { @@ -3341,6 +3545,9 @@ func (p *ListHostsMetricsParams) toURLValues() url.Values { if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } + if v, found := p.p["managementserverid"]; found { + u.Set("managementserverid", v.(string)) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -3368,6 +3575,9 @@ func (p *ListHostsMetricsParams) toURLValues() url.Values { if v, found := p.p["state"]; found { u.Set("state", v.(string)) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["type"]; found { u.Set("type", v.(string)) } @@ -3527,6 +3737,27 @@ func (p *ListHostsMetricsParams) GetKeyword() (string, bool) { return value, ok } +func (p *ListHostsMetricsParams) SetManagementserverid(v UUID) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["managementserverid"] = v +} + +func (p *ListHostsMetricsParams) ResetManagementserverid() { + if p.p != nil && p.p["managementserverid"] != nil { + delete(p.p, "managementserverid") + } +} + +func (p *ListHostsMetricsParams) GetManagementserverid() (UUID, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["managementserverid"].(UUID) + return value, ok +} + func (p *ListHostsMetricsParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3695,6 +3926,27 @@ func (p *ListHostsMetricsParams) GetState() (string, bool) { return value, ok } +func (p *ListHostsMetricsParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListHostsMetricsParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListHostsMetricsParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListHostsMetricsParams) SetType(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3875,6 +4127,7 @@ type HostsMetric struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocateddisablethreshold bool `json:"cpuallocateddisablethreshold"` @@ -3901,7 +4154,11 @@ type HostsMetric struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []HostsMetricGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -3921,6 +4178,7 @@ type HostsMetric struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocateddisablethreshold bool `json:"memoryallocateddisablethreshold"` @@ -3944,18 +4202,22 @@ type HostsMetric struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Powerstate string `json:"powerstate"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Systeminstances string `json:"systeminstances"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type HostsMetricGpugroup struct { @@ -4060,6 +4322,7 @@ type PrepareHostForMaintenanceResponse struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -4079,7 +4342,11 @@ type PrepareHostForMaintenanceResponse struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []PrepareHostForMaintenanceResponseGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -4098,6 +4365,7 @@ type PrepareHostForMaintenanceResponse struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -4112,16 +4380,20 @@ type PrepareHostForMaintenanceResponse struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type PrepareHostForMaintenanceResponseGpugroup struct { @@ -4226,6 +4498,7 @@ type ReconnectHostResponse struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -4245,7 +4518,11 @@ type ReconnectHostResponse struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []ReconnectHostResponseGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -4264,6 +4541,7 @@ type ReconnectHostResponse struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -4278,16 +4556,20 @@ type ReconnectHostResponse struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type ReconnectHostResponseGpugroup struct { @@ -4485,6 +4767,13 @@ func (p *UpdateHostParams) toURLValues() url.Values { if v, found := p.p["annotation"]; found { u.Set("annotation", v.(string)) } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } if v, found := p.p["hosttags"]; found { vv := strings.Join(v.([]string), ",") u.Set("hosttags", vv) @@ -4550,6 +4839,27 @@ func (p *UpdateHostParams) GetAnnotation() (string, bool) { return value, ok } +func (p *UpdateHostParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *UpdateHostParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *UpdateHostParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + func (p *UpdateHostParams) SetHosttags(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4706,6 +5016,7 @@ type UpdateHostResponse struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -4725,7 +5036,11 @@ type UpdateHostResponse struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []UpdateHostResponseGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -4744,6 +5059,7 @@ type UpdateHostResponse struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -4758,16 +5074,20 @@ type UpdateHostResponse struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type UpdateHostResponseGpugroup struct { @@ -5202,6 +5522,7 @@ type CancelHostAsDegradedResponse struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -5221,7 +5542,11 @@ type CancelHostAsDegradedResponse struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []CancelHostAsDegradedResponseGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -5240,6 +5565,7 @@ type CancelHostAsDegradedResponse struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -5254,16 +5580,20 @@ type CancelHostAsDegradedResponse struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type CancelHostAsDegradedResponseGpugroup struct { @@ -6025,6 +6355,7 @@ type DeclareHostAsDegradedResponse struct { Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` + Clusterstorageaccessgroups string `json:"clusterstorageaccessgroups"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` Cpuallocatedpercentage string `json:"cpuallocatedpercentage"` @@ -6044,7 +6375,11 @@ type DeclareHostAsDegradedResponse struct { Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` Explicithosttags string `json:"explicithosttags"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` Gpugroup []DeclareHostAsDegradedResponseGpugroup `json:"gpugroup"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` Hasenoughcapacity bool `json:"hasenoughcapacity"` @@ -6063,6 +6398,7 @@ type DeclareHostAsDegradedResponse struct { Lastannotated string `json:"lastannotated"` Lastpinged string `json:"lastpinged"` Managementserverid UUID `json:"managementserverid"` + Managementservername string `json:"managementservername"` Memoryallocated int64 `json:"memoryallocated"` Memoryallocatedbytes int64 `json:"memoryallocatedbytes"` Memoryallocatedpercentage string `json:"memoryallocatedpercentage"` @@ -6077,16 +6413,20 @@ type DeclareHostAsDegradedResponse struct { Outofbandmanagement OutOfBandManagementResponse `json:"outofbandmanagement"` Podid string `json:"podid"` Podname string `json:"podname"` + Podstorageaccessgroups string `json:"podstorageaccessgroups"` Removed string `json:"removed"` Resourcestate string `json:"resourcestate"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Suitableformigration bool `json:"suitableformigration"` Type string `json:"type"` Ueficapability bool `json:"ueficapability"` Username string `json:"username"` Version string `json:"version"` + Virtualmachineid string `json:"virtualmachineid"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type DeclareHostAsDegradedResponseGpugroup struct { diff --git a/cloudstack/ISOService.go b/cloudstack/ISOService.go index 1ceb3951..5000bc5f 100644 --- a/cloudstack/ISOService.go +++ b/cloudstack/ISOService.go @@ -214,6 +214,9 @@ type AttachIsoResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -235,6 +238,12 @@ type AttachIsoResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -276,6 +285,9 @@ type AttachIsoResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -527,6 +539,9 @@ type CopyIsoResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -833,6 +848,9 @@ type DetachIsoResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -854,6 +872,12 @@ type DetachIsoResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -895,6 +919,9 @@ type DetachIsoResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -1674,6 +1701,9 @@ func (p *ListIsosParams) toURLValues() url.Values { if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["oscategoryid"]; found { + u.Set("oscategoryid", v.(string)) + } if v, found := p.p["page"]; found { vv := strconv.Itoa(v.(int)) u.Set("page", vv) @@ -2007,6 +2037,27 @@ func (p *ListIsosParams) GetName() (string, bool) { return value, ok } +func (p *ListIsosParams) SetOscategoryid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["oscategoryid"] = v +} + +func (p *ListIsosParams) ResetOscategoryid() { + if p.p != nil && p.p["oscategoryid"] != nil { + delete(p.p, "oscategoryid") + } +} + +func (p *ListIsosParams) GetOscategoryid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["oscategoryid"].(string) + return value, ok +} + func (p *ListIsosParams) SetPage(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2328,6 +2379,9 @@ type Iso struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -2896,6 +2950,9 @@ type RegisterIsoResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -2992,6 +3049,10 @@ func (p *UpdateIsoParams) toURLValues() url.Values { if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } + if v, found := p.p["forceupdateostype"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forceupdateostype", vv) + } if v, found := p.p["format"]; found { u.Set("format", v.(string)) } @@ -3136,6 +3197,27 @@ func (p *UpdateIsoParams) GetDisplaytext() (string, bool) { return value, ok } +func (p *UpdateIsoParams) SetForceupdateostype(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forceupdateostype"] = v +} + +func (p *UpdateIsoParams) ResetForceupdateostype() { + if p.p != nil && p.p["forceupdateostype"] != nil { + delete(p.p, "forceupdateostype") + } +} + +func (p *UpdateIsoParams) GetForceupdateostype() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forceupdateostype"].(bool) + return value, ok +} + func (p *UpdateIsoParams) SetFormat(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3389,6 +3471,9 @@ type UpdateIsoResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index 426d4109..35064e28 100644 --- a/cloudstack/KubernetesService.go +++ b/cloudstack/KubernetesService.go @@ -358,9 +358,22 @@ func (p *CreateKubernetesClusterParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["asnumber"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("asnumber", vv) + } if v, found := p.p["clustertype"]; found { u.Set("clustertype", v.(string)) } + if v, found := p.p["cniconfigdetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("cniconfigdetails[%d].%s", i, k), m[k]) + } + } + if v, found := p.p["cniconfigurationid"]; found { + u.Set("cniconfigurationid", v.(string)) + } if v, found := p.p["controlnodes"]; found { vv := strconv.FormatInt(v.(int64), 10) u.Set("controlnodes", vv) @@ -380,9 +393,16 @@ func (p *CreateKubernetesClusterParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["etcdnodes"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("etcdnodes", vv) + } if v, found := p.p["externalloadbalanceripaddress"]; found { u.Set("externalloadbalanceripaddress", v.(string)) } + if v, found := p.p["hypervisor"]; found { + u.Set("hypervisor", v.(string)) + } if v, found := p.p["keypair"]; found { u.Set("keypair", v.(string)) } @@ -399,10 +419,24 @@ func (p *CreateKubernetesClusterParams) toURLValues() url.Values { if v, found := p.p["networkid"]; found { u.Set("networkid", v.(string)) } + if v, found := p.p["nodeofferings"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("nodeofferings[%d].node", i), k) + u.Set(fmt.Sprintf("nodeofferings[%d].offering", i), m[k]) + } + } if v, found := p.p["noderootdisksize"]; found { vv := strconv.FormatInt(v.(int64), 10) u.Set("noderootdisksize", vv) } + if v, found := p.p["nodetemplates"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("nodetemplates[%d].node", i), k) + u.Set(fmt.Sprintf("nodetemplates[%d].template", i), m[k]) + } + } if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } @@ -440,6 +474,27 @@ func (p *CreateKubernetesClusterParams) GetAccount() (string, bool) { return value, ok } +func (p *CreateKubernetesClusterParams) SetAsnumber(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["asnumber"] = v +} + +func (p *CreateKubernetesClusterParams) ResetAsnumber() { + if p.p != nil && p.p["asnumber"] != nil { + delete(p.p, "asnumber") + } +} + +func (p *CreateKubernetesClusterParams) GetAsnumber() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["asnumber"].(int64) + return value, ok +} + func (p *CreateKubernetesClusterParams) SetClustertype(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -461,6 +516,48 @@ func (p *CreateKubernetesClusterParams) GetClustertype() (string, bool) { return value, ok } +func (p *CreateKubernetesClusterParams) SetCniconfigdetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cniconfigdetails"] = v +} + +func (p *CreateKubernetesClusterParams) ResetCniconfigdetails() { + if p.p != nil && p.p["cniconfigdetails"] != nil { + delete(p.p, "cniconfigdetails") + } +} + +func (p *CreateKubernetesClusterParams) GetCniconfigdetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cniconfigdetails"].(map[string]string) + return value, ok +} + +func (p *CreateKubernetesClusterParams) SetCniconfigurationid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cniconfigurationid"] = v +} + +func (p *CreateKubernetesClusterParams) ResetCniconfigurationid() { + if p.p != nil && p.p["cniconfigurationid"] != nil { + delete(p.p, "cniconfigurationid") + } +} + +func (p *CreateKubernetesClusterParams) GetCniconfigurationid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cniconfigurationid"].(string) + return value, ok +} + func (p *CreateKubernetesClusterParams) SetControlnodes(v int64) { if p.p == nil { p.p = make(map[string]interface{}) @@ -587,6 +684,27 @@ func (p *CreateKubernetesClusterParams) GetDomainid() (string, bool) { return value, ok } +func (p *CreateKubernetesClusterParams) SetEtcdnodes(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["etcdnodes"] = v +} + +func (p *CreateKubernetesClusterParams) ResetEtcdnodes() { + if p.p != nil && p.p["etcdnodes"] != nil { + delete(p.p, "etcdnodes") + } +} + +func (p *CreateKubernetesClusterParams) GetEtcdnodes() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["etcdnodes"].(int64) + return value, ok +} + func (p *CreateKubernetesClusterParams) SetExternalloadbalanceripaddress(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -608,6 +726,27 @@ func (p *CreateKubernetesClusterParams) GetExternalloadbalanceripaddress() (stri return value, ok } +func (p *CreateKubernetesClusterParams) SetHypervisor(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hypervisor"] = v +} + +func (p *CreateKubernetesClusterParams) ResetHypervisor() { + if p.p != nil && p.p["hypervisor"] != nil { + delete(p.p, "hypervisor") + } +} + +func (p *CreateKubernetesClusterParams) GetHypervisor() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hypervisor"].(string) + return value, ok +} + func (p *CreateKubernetesClusterParams) SetKeypair(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -713,6 +852,27 @@ func (p *CreateKubernetesClusterParams) GetNetworkid() (string, bool) { return value, ok } +func (p *CreateKubernetesClusterParams) SetNodeofferings(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nodeofferings"] = v +} + +func (p *CreateKubernetesClusterParams) ResetNodeofferings() { + if p.p != nil && p.p["nodeofferings"] != nil { + delete(p.p, "nodeofferings") + } +} + +func (p *CreateKubernetesClusterParams) GetNodeofferings() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nodeofferings"].(map[string]string) + return value, ok +} + func (p *CreateKubernetesClusterParams) SetNoderootdisksize(v int64) { if p.p == nil { p.p = make(map[string]interface{}) @@ -734,6 +894,27 @@ func (p *CreateKubernetesClusterParams) GetNoderootdisksize() (int64, bool) { return value, ok } +func (p *CreateKubernetesClusterParams) SetNodetemplates(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nodetemplates"] = v +} + +func (p *CreateKubernetesClusterParams) ResetNodetemplates() { + if p.p != nil && p.p["nodetemplates"] != nil { + delete(p.p, "nodetemplates") + } +} + +func (p *CreateKubernetesClusterParams) GetNodetemplates() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nodetemplates"].(map[string]string) + return value, ok +} + func (p *CreateKubernetesClusterParams) SetProjectid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -872,8 +1053,12 @@ type CreateKubernetesClusterResponse struct { Associatednetworkname string `json:"associatednetworkname"` Autoscalingenabled bool `json:"autoscalingenabled"` Clustertype string `json:"clustertype"` + Cniconfigname string `json:"cniconfigname"` + Cniconfigurationid string `json:"cniconfigurationid"` Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` + Controlofferingid string `json:"controlofferingid"` + Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` Description string `json:"description"` @@ -881,6 +1066,10 @@ type CreateKubernetesClusterResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` + Etcdips map[string]string `json:"etcdips"` + Etcdnodes int64 `json:"etcdnodes"` + Etcdofferingid string `json:"etcdofferingid"` + Etcdofferingname string `json:"etcdofferingname"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` @@ -904,6 +1093,8 @@ type CreateKubernetesClusterResponse struct { State string `json:"state"` Templateid string `json:"templateid"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` + Workerofferingid string `json:"workerofferingid"` + Workerofferingname string `json:"workerofferingname"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -1612,8 +1803,12 @@ type KubernetesCluster struct { Associatednetworkname string `json:"associatednetworkname"` Autoscalingenabled bool `json:"autoscalingenabled"` Clustertype string `json:"clustertype"` + Cniconfigname string `json:"cniconfigname"` + Cniconfigurationid string `json:"cniconfigurationid"` Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` + Controlofferingid string `json:"controlofferingid"` + Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` Description string `json:"description"` @@ -1621,6 +1816,10 @@ type KubernetesCluster struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` + Etcdips map[string]string `json:"etcdips"` + Etcdnodes int64 `json:"etcdnodes"` + Etcdofferingid string `json:"etcdofferingid"` + Etcdofferingname string `json:"etcdofferingname"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` @@ -1644,6 +1843,8 @@ type KubernetesCluster struct { State string `json:"state"` Templateid string `json:"templateid"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` + Workerofferingid string `json:"workerofferingid"` + Workerofferingname string `json:"workerofferingname"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2014,6 +2215,13 @@ func (p *ScaleKubernetesClusterParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("nodeids", vv) } + if v, found := p.p["nodeofferings"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("nodeofferings[%d].node", i), k) + u.Set(fmt.Sprintf("nodeofferings[%d].offering", i), m[k]) + } + } if v, found := p.p["serviceofferingid"]; found { u.Set("serviceofferingid", v.(string)) } @@ -2129,6 +2337,27 @@ func (p *ScaleKubernetesClusterParams) GetNodeids() ([]string, bool) { return value, ok } +func (p *ScaleKubernetesClusterParams) SetNodeofferings(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nodeofferings"] = v +} + +func (p *ScaleKubernetesClusterParams) ResetNodeofferings() { + if p.p != nil && p.p["nodeofferings"] != nil { + delete(p.p, "nodeofferings") + } +} + +func (p *ScaleKubernetesClusterParams) GetNodeofferings() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nodeofferings"].(map[string]string) + return value, ok +} + func (p *ScaleKubernetesClusterParams) SetServiceofferingid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2220,8 +2449,12 @@ type ScaleKubernetesClusterResponse struct { Associatednetworkname string `json:"associatednetworkname"` Autoscalingenabled bool `json:"autoscalingenabled"` Clustertype string `json:"clustertype"` + Cniconfigname string `json:"cniconfigname"` + Cniconfigurationid string `json:"cniconfigurationid"` Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` + Controlofferingid string `json:"controlofferingid"` + Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` Description string `json:"description"` @@ -2229,6 +2462,10 @@ type ScaleKubernetesClusterResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` + Etcdips map[string]string `json:"etcdips"` + Etcdnodes int64 `json:"etcdnodes"` + Etcdofferingid string `json:"etcdofferingid"` + Etcdofferingname string `json:"etcdofferingname"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` @@ -2252,6 +2489,8 @@ type ScaleKubernetesClusterResponse struct { State string `json:"state"` Templateid string `json:"templateid"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` + Workerofferingid string `json:"workerofferingid"` + Workerofferingname string `json:"workerofferingname"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2341,8 +2580,12 @@ type StartKubernetesClusterResponse struct { Associatednetworkname string `json:"associatednetworkname"` Autoscalingenabled bool `json:"autoscalingenabled"` Clustertype string `json:"clustertype"` + Cniconfigname string `json:"cniconfigname"` + Cniconfigurationid string `json:"cniconfigurationid"` Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` + Controlofferingid string `json:"controlofferingid"` + Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` Description string `json:"description"` @@ -2350,6 +2593,10 @@ type StartKubernetesClusterResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` + Etcdips map[string]string `json:"etcdips"` + Etcdnodes int64 `json:"etcdnodes"` + Etcdofferingid string `json:"etcdofferingid"` + Etcdofferingname string `json:"etcdofferingname"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` @@ -2373,6 +2620,8 @@ type StartKubernetesClusterResponse struct { State string `json:"state"` Templateid string `json:"templateid"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` + Workerofferingid string `json:"workerofferingid"` + Workerofferingname string `json:"workerofferingname"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } @@ -2675,8 +2924,12 @@ type UpgradeKubernetesClusterResponse struct { Associatednetworkname string `json:"associatednetworkname"` Autoscalingenabled bool `json:"autoscalingenabled"` Clustertype string `json:"clustertype"` + Cniconfigname string `json:"cniconfigname"` + Cniconfigurationid string `json:"cniconfigurationid"` Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` + Controlofferingid string `json:"controlofferingid"` + Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` Description string `json:"description"` @@ -2684,6 +2937,10 @@ type UpgradeKubernetesClusterResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` + Etcdips map[string]string `json:"etcdips"` + Etcdnodes int64 `json:"etcdnodes"` + Etcdofferingid string `json:"etcdofferingid"` + Etcdofferingname string `json:"etcdofferingname"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` @@ -2707,6 +2964,8 @@ type UpgradeKubernetesClusterResponse struct { State string `json:"state"` Templateid string `json:"templateid"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` + Workerofferingid string `json:"workerofferingid"` + Workerofferingname string `json:"workerofferingname"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } diff --git a/cloudstack/LDAPService.go b/cloudstack/LDAPService.go index 5bfe1001..cc8af48c 100644 --- a/cloudstack/LDAPService.go +++ b/cloudstack/LDAPService.go @@ -1153,6 +1153,15 @@ type LdapCreateAccountResponse struct { Accountdetails map[string]string `json:"accountdetails"` Accounttype int `json:"accounttype"` Apikeyaccess string `json:"apikeyaccess"` + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -1161,6 +1170,9 @@ type LdapCreateAccountResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Groups []string `json:"groups"` Icon interface{} `json:"icon"` Id string `json:"id"` @@ -1179,6 +1191,9 @@ type LdapCreateAccountResponse struct { Networkdomain string `json:"networkdomain"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` Primarystoragetotal int64 `json:"primarystoragetotal"` diff --git a/cloudstack/ManagementService.go b/cloudstack/ManagementService.go index 3619c0f3..a8370f28 100644 --- a/cloudstack/ManagementService.go +++ b/cloudstack/ManagementService.go @@ -43,7 +43,7 @@ type ManagementServiceIface interface { PrepareForShutdown(p *PrepareForShutdownParams) (*PrepareForShutdownResponse, error) NewPrepareForShutdownParams(managementserverid UUID) *PrepareForShutdownParams ReadyForShutdown(p *ReadyForShutdownParams) (*ReadyForShutdownResponse, error) - NewReadyForShutdownParams() *ReadyForShutdownParams + NewReadyForShutdownParams(managementserverid UUID) *ReadyForShutdownParams TriggerShutdown(p *TriggerShutdownParams) (*TriggerShutdownResponse, error) NewTriggerShutdownParams(managementserverid UUID) *TriggerShutdownParams } @@ -109,12 +109,16 @@ func (s *ManagementService) CancelShutdown(p *CancelShutdownParams) (*CancelShut } type CancelShutdownResponse struct { - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Managementserverid UUID `json:"managementserverid"` - Pendingjobscount int64 `json:"pendingjobscount"` - Readyforshutdown bool `json:"readyforshutdown"` - Shutdowntriggered bool `json:"shutdowntriggered"` + Agents []string `json:"agents"` + Agentscount int64 `json:"agentscount"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maintenanceinitiated bool `json:"maintenanceinitiated"` + Managementserverid UUID `json:"managementserverid"` + Pendingjobscount int64 `json:"pendingjobscount"` + Readyforshutdown bool `json:"readyforshutdown"` + Shutdowntriggered bool `json:"shutdowntriggered"` + State string `json:"state"` } type ListManagementServersParams struct { @@ -388,6 +392,8 @@ type ListManagementServersResponse struct { } type ManagementServer struct { + Agents []string `json:"agents"` + Agentscount int64 `json:"agentscount"` Id string `json:"id"` Ipaddress string `json:"ipaddress"` Javadistribution string `json:"javadistribution"` @@ -395,12 +401,14 @@ type ManagementServer struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Kernelversion string `json:"kernelversion"` + Lastagents []string `json:"lastagents"` Lastboottime string `json:"lastboottime"` Lastserverstart string `json:"lastserverstart"` Lastserverstop string `json:"lastserverstop"` Name string `json:"name"` Osdistribution string `json:"osdistribution"` Peers []string `json:"peers"` + Pendingjobscount int64 `json:"pendingjobscount"` Serviceip string `json:"serviceip"` State string `json:"state"` Version string `json:"version"` @@ -703,6 +711,8 @@ type ListManagementServersMetricsResponse struct { type ManagementServersMetric struct { Agentcount int `json:"agentcount"` + Agents []string `json:"agents"` + Agentscount int64 `json:"agentscount"` Availableprocessors int `json:"availableprocessors"` Collectiontime string `json:"collectiontime"` Cpuload string `json:"cpuload"` @@ -716,6 +726,7 @@ type ManagementServersMetric struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Kernelversion string `json:"kernelversion"` + Lastagents []string `json:"lastagents"` Lastboottime string `json:"lastboottime"` Lastserverstart string `json:"lastserverstart"` Lastserverstop string `json:"lastserverstop"` @@ -723,6 +734,7 @@ type ManagementServersMetric struct { Name string `json:"name"` Osdistribution string `json:"osdistribution"` Peers []string `json:"peers"` + Pendingjobscount int64 `json:"pendingjobscount"` Serviceip string `json:"serviceip"` Sessions int64 `json:"sessions"` State string `json:"state"` @@ -804,12 +816,16 @@ func (s *ManagementService) PrepareForShutdown(p *PrepareForShutdownParams) (*Pr } type PrepareForShutdownResponse struct { - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Managementserverid UUID `json:"managementserverid"` - Pendingjobscount int64 `json:"pendingjobscount"` - Readyforshutdown bool `json:"readyforshutdown"` - Shutdowntriggered bool `json:"shutdowntriggered"` + Agents []string `json:"agents"` + Agentscount int64 `json:"agentscount"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maintenanceinitiated bool `json:"maintenanceinitiated"` + Managementserverid UUID `json:"managementserverid"` + Pendingjobscount int64 `json:"pendingjobscount"` + Readyforshutdown bool `json:"readyforshutdown"` + Shutdowntriggered bool `json:"shutdowntriggered"` + State string `json:"state"` } type ReadyForShutdownParams struct { @@ -850,9 +866,10 @@ func (p *ReadyForShutdownParams) GetManagementserverid() (UUID, bool) { // You should always use this function to get a new ReadyForShutdownParams instance, // as then you are sure you have configured all required params -func (s *ManagementService) NewReadyForShutdownParams() *ReadyForShutdownParams { +func (s *ManagementService) NewReadyForShutdownParams(managementserverid UUID) *ReadyForShutdownParams { p := &ReadyForShutdownParams{} p.p = make(map[string]interface{}) + p.p["managementserverid"] = managementserverid return p } @@ -875,12 +892,16 @@ func (s *ManagementService) ReadyForShutdown(p *ReadyForShutdownParams) (*ReadyF } type ReadyForShutdownResponse struct { - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Managementserverid UUID `json:"managementserverid"` - Pendingjobscount int64 `json:"pendingjobscount"` - Readyforshutdown bool `json:"readyforshutdown"` - Shutdowntriggered bool `json:"shutdowntriggered"` + Agents []string `json:"agents"` + Agentscount int64 `json:"agentscount"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maintenanceinitiated bool `json:"maintenanceinitiated"` + Managementserverid UUID `json:"managementserverid"` + Pendingjobscount int64 `json:"pendingjobscount"` + Readyforshutdown bool `json:"readyforshutdown"` + Shutdowntriggered bool `json:"shutdowntriggered"` + State string `json:"state"` } type TriggerShutdownParams struct { @@ -928,7 +949,7 @@ func (s *ManagementService) NewTriggerShutdownParams(managementserverid UUID) *T return p } -// Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced +// Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobs have been completed. func (s *ManagementService) TriggerShutdown(p *TriggerShutdownParams) (*TriggerShutdownResponse, error) { resp, err := s.cs.newPostRequest("triggerShutdown", p.toURLValues()) if err != nil { @@ -944,10 +965,14 @@ func (s *ManagementService) TriggerShutdown(p *TriggerShutdownParams) (*TriggerS } type TriggerShutdownResponse struct { - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Managementserverid UUID `json:"managementserverid"` - Pendingjobscount int64 `json:"pendingjobscount"` - Readyforshutdown bool `json:"readyforshutdown"` - Shutdowntriggered bool `json:"shutdowntriggered"` + Agents []string `json:"agents"` + Agentscount int64 `json:"agentscount"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maintenanceinitiated bool `json:"maintenanceinitiated"` + Managementserverid UUID `json:"managementserverid"` + Pendingjobscount int64 `json:"pendingjobscount"` + Readyforshutdown bool `json:"readyforshutdown"` + Shutdowntriggered bool `json:"shutdowntriggered"` + State string `json:"state"` } diff --git a/cloudstack/ManagementService_mock.go b/cloudstack/ManagementService_mock.go index 5a57d572..cf4bb983 100644 --- a/cloudstack/ManagementService_mock.go +++ b/cloudstack/ManagementService_mock.go @@ -286,17 +286,17 @@ func (mr *MockManagementServiceIfaceMockRecorder) NewPrepareForShutdownParams(ma } // NewReadyForShutdownParams mocks base method. -func (m *MockManagementServiceIface) NewReadyForShutdownParams() *ReadyForShutdownParams { +func (m *MockManagementServiceIface) NewReadyForShutdownParams(managementserverid UUID) *ReadyForShutdownParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewReadyForShutdownParams") + ret := m.ctrl.Call(m, "NewReadyForShutdownParams", managementserverid) ret0, _ := ret[0].(*ReadyForShutdownParams) return ret0 } // NewReadyForShutdownParams indicates an expected call of NewReadyForShutdownParams. -func (mr *MockManagementServiceIfaceMockRecorder) NewReadyForShutdownParams() *gomock.Call { +func (mr *MockManagementServiceIfaceMockRecorder) NewReadyForShutdownParams(managementserverid any) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewReadyForShutdownParams", reflect.TypeOf((*MockManagementServiceIface)(nil).NewReadyForShutdownParams)) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewReadyForShutdownParams", reflect.TypeOf((*MockManagementServiceIface)(nil).NewReadyForShutdownParams), managementserverid) } // NewTriggerShutdownParams mocks base method. diff --git a/cloudstack/NetworkOfferingService.go b/cloudstack/NetworkOfferingService.go index 9fa2148c..2d670bd0 100644 --- a/cloudstack/NetworkOfferingService.go +++ b/cloudstack/NetworkOfferingService.go @@ -126,6 +126,9 @@ func (p *CreateNetworkOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("nsxsupportsinternallb", vv) } + if v, found := p.p["provider"]; found { + u.Set("provider", v.(string)) + } if v, found := p.p["routingmode"]; found { u.Set("routingmode", v.(string)) } @@ -595,6 +598,27 @@ func (p *CreateNetworkOfferingParams) GetNsxsupportsinternallb() (bool, bool) { return value, ok } +func (p *CreateNetworkOfferingParams) SetProvider(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["provider"] = v +} + +func (p *CreateNetworkOfferingParams) ResetProvider() { + if p.p != nil && p.p["provider"] != nil { + delete(p.p, "provider") + } +} + +func (p *CreateNetworkOfferingParams) GetProvider() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["provider"].(string) + return value, ok +} + func (p *CreateNetworkOfferingParams) SetRoutingmode(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/NetworkService.go b/cloudstack/NetworkService.go index 924f1f6f..10b35bf5 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -2807,7 +2807,6 @@ type DedicatePublicIpRangeResponse struct { Domainpath string `json:"domainpath"` Endip string `json:"endip"` Endipv6 string `json:"endipv6"` - Fornsx bool `json:"fornsx"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Gateway string `json:"gateway"` @@ -2823,6 +2822,7 @@ type DedicatePublicIpRangeResponse struct { Podname string `json:"podname"` Project string `json:"project"` Projectid string `json:"projectid"` + Provider string `json:"provider"` Startip string `json:"startip"` Startipv6 string `json:"startipv6"` Vlan string `json:"vlan"` diff --git a/cloudstack/NicService.go b/cloudstack/NicService.go index 5c384fd2..3fe8f335 100644 --- a/cloudstack/NicService.go +++ b/cloudstack/NicService.go @@ -619,6 +619,9 @@ type UpdateVmNicIpResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -640,6 +643,12 @@ type UpdateVmNicIpResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -681,6 +690,9 @@ type UpdateVmNicIpResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` diff --git a/cloudstack/ObjectStoreService.go b/cloudstack/ObjectStoreService.go index a881797e..2422e000 100644 --- a/cloudstack/ObjectStoreService.go +++ b/cloudstack/ObjectStoreService.go @@ -29,7 +29,7 @@ import ( type ObjectStoreServiceIface interface { CreateBucket(p *CreateBucketParams) (*CreateBucketResponse, error) - NewCreateBucketParams(name string, objectstorageid string) *CreateBucketParams + NewCreateBucketParams(name string, objectstorageid string, quota int) *CreateBucketParams DeleteBucket(p *DeleteBucketParams) (*DeleteBucketResponse, error) NewDeleteBucketParams(id string) *DeleteBucketParams UpdateBucket(p *UpdateBucketParams) (*UpdateBucketResponse, error) @@ -299,11 +299,12 @@ func (p *CreateBucketParams) GetVersioning() (bool, bool) { // You should always use this function to get a new CreateBucketParams instance, // as then you are sure you have configured all required params -func (s *ObjectStoreService) NewCreateBucketParams(name string, objectstorageid string) *CreateBucketParams { +func (s *ObjectStoreService) NewCreateBucketParams(name string, objectstorageid string, quota int) *CreateBucketParams { p := &CreateBucketParams{} p.p = make(map[string]interface{}) p.p["name"] = name p.p["objectstorageid"] = objectstorageid + p.p["quota"] = quota return p } diff --git a/cloudstack/ObjectStoreService_mock.go b/cloudstack/ObjectStoreService_mock.go index 41dfa4b5..10dbaf6c 100644 --- a/cloudstack/ObjectStoreService_mock.go +++ b/cloudstack/ObjectStoreService_mock.go @@ -167,17 +167,17 @@ func (mr *MockObjectStoreServiceIfaceMockRecorder) ListBuckets(p any) *gomock.Ca } // NewCreateBucketParams mocks base method. -func (m *MockObjectStoreServiceIface) NewCreateBucketParams(name, objectstorageid string) *CreateBucketParams { +func (m *MockObjectStoreServiceIface) NewCreateBucketParams(name, objectstorageid string, quota int) *CreateBucketParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreateBucketParams", name, objectstorageid) + ret := m.ctrl.Call(m, "NewCreateBucketParams", name, objectstorageid, quota) ret0, _ := ret[0].(*CreateBucketParams) return ret0 } // NewCreateBucketParams indicates an expected call of NewCreateBucketParams. -func (mr *MockObjectStoreServiceIfaceMockRecorder) NewCreateBucketParams(name, objectstorageid any) *gomock.Call { +func (mr *MockObjectStoreServiceIfaceMockRecorder) NewCreateBucketParams(name, objectstorageid, quota any) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateBucketParams", reflect.TypeOf((*MockObjectStoreServiceIface)(nil).NewCreateBucketParams), name, objectstorageid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateBucketParams", reflect.TypeOf((*MockObjectStoreServiceIface)(nil).NewCreateBucketParams), name, objectstorageid, quota) } // NewDeleteBucketParams mocks base method. diff --git a/cloudstack/PodService.go b/cloudstack/PodService.go index b1cbaa30..9bf7fb79 100644 --- a/cloudstack/PodService.go +++ b/cloudstack/PodService.go @@ -282,22 +282,24 @@ func (s *PodService) CreateManagementNetworkIpRange(p *CreateManagementNetworkIp } type CreateManagementNetworkIpRangeResponse struct { - Allocationstate string `json:"allocationstate"` - Capacity []CreateManagementNetworkIpRangeResponseCapacity `json:"capacity"` - Endip []string `json:"endip"` - Forsystemvms []string `json:"forsystemvms"` - Gateway string `json:"gateway"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Ipranges []CreateManagementNetworkIpRangeResponseIpranges `json:"ipranges"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Netmask string `json:"netmask"` - Startip []string `json:"startip"` - Vlanid []string `json:"vlanid"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Allocationstate string `json:"allocationstate"` + Capacity []CreateManagementNetworkIpRangeResponseCapacity `json:"capacity"` + Endip []string `json:"endip"` + Forsystemvms []string `json:"forsystemvms"` + Gateway string `json:"gateway"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Ipranges []CreateManagementNetworkIpRangeResponseIpranges `json:"ipranges"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Netmask string `json:"netmask"` + Startip []string `json:"startip"` + Storageaccessgroups string `json:"storageaccessgroups"` + Vlanid []string `json:"vlanid"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type CreateManagementNetworkIpRangeResponseIpranges struct { @@ -352,6 +354,10 @@ func (p *CreatePodParams) toURLValues() url.Values { if v, found := p.p["startip"]; found { u.Set("startip", v.(string)) } + if v, found := p.p["storageaccessgroups"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("storageaccessgroups", vv) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -484,6 +490,27 @@ func (p *CreatePodParams) GetStartip() (string, bool) { return value, ok } +func (p *CreatePodParams) SetStorageaccessgroups(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroups"] = v +} + +func (p *CreatePodParams) ResetStorageaccessgroups() { + if p.p != nil && p.p["storageaccessgroups"] != nil { + delete(p.p, "storageaccessgroups") + } +} + +func (p *CreatePodParams) GetStorageaccessgroups() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroups"].([]string) + return value, ok +} + func (p *CreatePodParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -535,22 +562,24 @@ func (s *PodService) CreatePod(p *CreatePodParams) (*CreatePodResponse, error) { } type CreatePodResponse struct { - Allocationstate string `json:"allocationstate"` - Capacity []CreatePodResponseCapacity `json:"capacity"` - Endip []string `json:"endip"` - Forsystemvms []string `json:"forsystemvms"` - Gateway string `json:"gateway"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Ipranges []CreatePodResponseIpranges `json:"ipranges"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Netmask string `json:"netmask"` - Startip []string `json:"startip"` - Vlanid []string `json:"vlanid"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Allocationstate string `json:"allocationstate"` + Capacity []CreatePodResponseCapacity `json:"capacity"` + Endip []string `json:"endip"` + Forsystemvms []string `json:"forsystemvms"` + Gateway string `json:"gateway"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Ipranges []CreatePodResponseIpranges `json:"ipranges"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Netmask string `json:"netmask"` + Startip []string `json:"startip"` + Storageaccessgroups string `json:"storageaccessgroups"` + Vlanid []string `json:"vlanid"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type CreatePodResponseIpranges struct { @@ -1223,6 +1252,9 @@ func (p *ListPodsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("showcapacities", vv) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -1376,6 +1408,27 @@ func (p *ListPodsParams) GetShowcapacities() (bool, bool) { return value, ok } +func (p *ListPodsParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListPodsParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListPodsParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListPodsParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1509,22 +1562,24 @@ type ListPodsResponse struct { } type Pod struct { - Allocationstate string `json:"allocationstate"` - Capacity []PodCapacity `json:"capacity"` - Endip []string `json:"endip"` - Forsystemvms []string `json:"forsystemvms"` - Gateway string `json:"gateway"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Ipranges []PodIpranges `json:"ipranges"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Netmask string `json:"netmask"` - Startip []string `json:"startip"` - Vlanid []string `json:"vlanid"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Allocationstate string `json:"allocationstate"` + Capacity []PodCapacity `json:"capacity"` + Endip []string `json:"endip"` + Forsystemvms []string `json:"forsystemvms"` + Gateway string `json:"gateway"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Ipranges []PodIpranges `json:"ipranges"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Netmask string `json:"netmask"` + Startip []string `json:"startip"` + Storageaccessgroups string `json:"storageaccessgroups"` + Vlanid []string `json:"vlanid"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type PodIpranges struct { @@ -1843,22 +1898,24 @@ func (s *PodService) UpdatePod(p *UpdatePodParams) (*UpdatePodResponse, error) { } type UpdatePodResponse struct { - Allocationstate string `json:"allocationstate"` - Capacity []UpdatePodResponseCapacity `json:"capacity"` - Endip []string `json:"endip"` - Forsystemvms []string `json:"forsystemvms"` - Gateway string `json:"gateway"` - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - Ipranges []UpdatePodResponseIpranges `json:"ipranges"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Netmask string `json:"netmask"` - Startip []string `json:"startip"` - Vlanid []string `json:"vlanid"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Allocationstate string `json:"allocationstate"` + Capacity []UpdatePodResponseCapacity `json:"capacity"` + Endip []string `json:"endip"` + Forsystemvms []string `json:"forsystemvms"` + Gateway string `json:"gateway"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Ipranges []UpdatePodResponseIpranges `json:"ipranges"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Netmask string `json:"netmask"` + Startip []string `json:"startip"` + Storageaccessgroups string `json:"storageaccessgroups"` + Vlanid []string `json:"vlanid"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` + Zonestorageaccessgroups string `json:"zonestorageaccessgroups"` } type UpdatePodResponseIpranges struct { diff --git a/cloudstack/PoolService.go b/cloudstack/PoolService.go index d074b048..885a44c7 100644 --- a/cloudstack/PoolService.go +++ b/cloudstack/PoolService.go @@ -96,6 +96,9 @@ func (p *CreateStoragePoolParams) toURLValues() url.Values { if v, found := p.p["scope"]; found { u.Set("scope", v.(string)) } + if v, found := p.p["storageaccessgroups"]; found { + u.Set("storageaccessgroups", v.(string)) + } if v, found := p.p["tags"]; found { u.Set("tags", v.(string)) } @@ -339,6 +342,27 @@ func (p *CreateStoragePoolParams) GetScope() (string, bool) { return value, ok } +func (p *CreateStoragePoolParams) SetStorageaccessgroups(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroups"] = v +} + +func (p *CreateStoragePoolParams) ResetStorageaccessgroups() { + if p.p != nil && p.p["storageaccessgroups"] != nil { + delete(p.p, "storageaccessgroups") + } +} + +func (p *CreateStoragePoolParams) GetStorageaccessgroups() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroups"].(string) + return value, ok +} + func (p *CreateStoragePoolParams) SetTags(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -438,6 +462,7 @@ type CreateStoragePoolResponse struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Disksizeused int64 `json:"disksizeused"` @@ -458,6 +483,7 @@ type CreateStoragePoolResponse struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storagecapabilities map[string]string `json:"storagecapabilities"` Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` @@ -727,6 +753,7 @@ type FindStoragePoolsForMigrationResponse struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Disksizeused int64 `json:"disksizeused"` @@ -747,6 +774,7 @@ type FindStoragePoolsForMigrationResponse struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storagecapabilities map[string]string `json:"storagecapabilities"` Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` @@ -881,6 +909,9 @@ func (p *ListStoragePoolsParams) toURLValues() url.Values { if v, found := p.p["status"]; found { u.Set("status", v.(string)) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["storagecustomstats"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("storagecustomstats", vv) @@ -1143,6 +1174,27 @@ func (p *ListStoragePoolsParams) GetStatus() (string, bool) { return value, ok } +func (p *ListStoragePoolsParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListStoragePoolsParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListStoragePoolsParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListStoragePoolsParams) SetStoragecustomstats(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1302,6 +1354,7 @@ type StoragePool struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Disksizeused int64 `json:"disksizeused"` @@ -1322,6 +1375,7 @@ type StoragePool struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storagecapabilities map[string]string `json:"storagecapabilities"` Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` @@ -1418,6 +1472,7 @@ type SyncStoragePoolResponse struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Disksizeused int64 `json:"disksizeused"` @@ -1438,6 +1493,7 @@ type SyncStoragePoolResponse struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storagecapabilities map[string]string `json:"storagecapabilities"` Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` @@ -1714,6 +1770,7 @@ type UpdateStoragePoolResponse struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Disksizeused int64 `json:"disksizeused"` @@ -1734,6 +1791,7 @@ type UpdateStoragePoolResponse struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storagecapabilities map[string]string `json:"storagecapabilities"` Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` diff --git a/cloudstack/ProjectService.go b/cloudstack/ProjectService.go index 8b2c75aa..bbafee4f 100644 --- a/cloudstack/ProjectService.go +++ b/cloudstack/ProjectService.go @@ -155,6 +155,15 @@ func (s *ProjectService) ActivateProject(p *ActivateProjectParams) (*ActivatePro } type ActivateProjectResponse struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -162,6 +171,9 @@ type ActivateProjectResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Icon interface{} `json:"icon"` Id string `json:"id"` Ipavailable string `json:"ipavailable"` @@ -176,6 +188,9 @@ type ActivateProjectResponse struct { Networkavailable string `json:"networkavailable"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Owner []map[string]string `json:"owner"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` @@ -765,6 +780,15 @@ func (s *ProjectService) CreateProject(p *CreateProjectParams) (*CreateProjectRe } type CreateProjectResponse struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -772,6 +796,9 @@ type CreateProjectResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Icon interface{} `json:"icon"` Id string `json:"id"` Ipavailable string `json:"ipavailable"` @@ -786,6 +813,9 @@ type CreateProjectResponse struct { Networkavailable string `json:"networkavailable"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Owner []map[string]string `json:"owner"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` @@ -2094,6 +2124,15 @@ type ListProjectsResponse struct { } type Project struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2101,6 +2140,9 @@ type Project struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Icon interface{} `json:"icon"` Id string `json:"id"` Ipavailable string `json:"ipavailable"` @@ -2115,6 +2157,9 @@ type Project struct { Networkavailable string `json:"networkavailable"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Owner []map[string]string `json:"owner"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` @@ -2226,6 +2271,15 @@ func (s *ProjectService) SuspendProject(p *SuspendProjectParams) (*SuspendProjec } type SuspendProjectResponse struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2233,6 +2287,9 @@ type SuspendProjectResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Icon interface{} `json:"icon"` Id string `json:"id"` Ipavailable string `json:"ipavailable"` @@ -2247,6 +2304,9 @@ type SuspendProjectResponse struct { Networkavailable string `json:"networkavailable"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Owner []map[string]string `json:"owner"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` @@ -2503,6 +2563,15 @@ func (s *ProjectService) UpdateProject(p *UpdateProjectParams) (*UpdateProjectRe } type UpdateProjectResponse struct { + Backupavailable string `json:"backupavailable"` + Backuplimit string `json:"backuplimit"` + Backupstorageavailable string `json:"backupstorageavailable"` + Backupstoragelimit string `json:"backupstoragelimit"` + Backupstoragetotal int64 `json:"backupstoragetotal"` + Backuptotal int64 `json:"backuptotal"` + Bucketavailable string `json:"bucketavailable"` + Bucketlimit string `json:"bucketlimit"` + Buckettotal int64 `json:"buckettotal"` Cpuavailable string `json:"cpuavailable"` Cpulimit string `json:"cpulimit"` Cputotal int64 `json:"cputotal"` @@ -2510,6 +2579,9 @@ type UpdateProjectResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Gpuavailable string `json:"gpuavailable"` + Gpulimit string `json:"gpulimit"` + Gputotal int64 `json:"gputotal"` Icon interface{} `json:"icon"` Id string `json:"id"` Ipavailable string `json:"ipavailable"` @@ -2524,6 +2596,9 @@ type UpdateProjectResponse struct { Networkavailable string `json:"networkavailable"` Networklimit string `json:"networklimit"` Networktotal int64 `json:"networktotal"` + Objectstorageavailable string `json:"objectstorageavailable"` + Objectstoragelimit string `json:"objectstoragelimit"` + Objectstoragetotal int64 `json:"objectstoragetotal"` Owner []map[string]string `json:"owner"` Primarystorageavailable string `json:"primarystorageavailable"` Primarystoragelimit string `json:"primarystoragelimit"` diff --git a/cloudstack/QuotaService.go b/cloudstack/QuotaService.go index fa4ba771..ac50a388 100644 --- a/cloudstack/QuotaService.go +++ b/cloudstack/QuotaService.go @@ -378,12 +378,13 @@ func (s *QuotaService) QuotaCredits(p *QuotaCreditsParams) (*QuotaCreditsRespons } type QuotaCreditsResponse struct { - Credits float64 `json:"credits"` - Currency string `json:"currency"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Updated_by string `json:"updated_by"` - Updated_on string `json:"updated_on"` + Credit float64 `json:"credit"` + Creditedon string `json:"creditedon"` + Creditoruserid string `json:"creditoruserid"` + Creditorusername string `json:"creditorusername"` + Currency string `json:"currency"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` } type QuotaIsEnabledParams struct { diff --git a/cloudstack/SSHService.go b/cloudstack/SSHService.go index 03c2ec87..30038d47 100644 --- a/cloudstack/SSHService.go +++ b/cloudstack/SSHService.go @@ -1169,6 +1169,9 @@ type ResetSSHKeyForVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -1190,6 +1193,12 @@ type ResetSSHKeyForVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -1231,6 +1240,9 @@ type ResetSSHKeyForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` diff --git a/cloudstack/ServiceOfferingService.go b/cloudstack/ServiceOfferingService.go index d55a6888..61238ab8 100644 --- a/cloudstack/ServiceOfferingService.go +++ b/cloudstack/ServiceOfferingService.go @@ -118,6 +118,21 @@ func (p *CreateServiceOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("encryptroot", vv) } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } + if v, found := p.p["gpucount"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("gpucount", vv) + } + if v, found := p.p["gpudisplay"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("gpudisplay", vv) + } if v, found := p.p["hosttags"]; found { u.Set("hosttags", v.(string)) } @@ -157,6 +172,13 @@ func (p *CreateServiceOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("isvolatile", vv) } + if v, found := p.p["leaseduration"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("leaseduration", vv) + } + if v, found := p.p["leaseexpiryaction"]; found { + u.Set("leaseexpiryaction", v.(string)) + } if v, found := p.p["limitcpuuse"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("limitcpuuse", vv) @@ -230,6 +252,9 @@ func (p *CreateServiceOfferingParams) toURLValues() url.Values { if v, found := p.p["tags"]; found { u.Set("tags", v.(string)) } + if v, found := p.p["vgpuprofileid"]; found { + u.Set("vgpuprofileid", v.(string)) + } if v, found := p.p["zoneid"]; found { vv := strings.Join(v.([]string), ",") u.Set("zoneid", vv) @@ -615,6 +640,69 @@ func (p *CreateServiceOfferingParams) GetEncryptroot() (bool, bool) { return value, ok } +func (p *CreateServiceOfferingParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *CreateServiceOfferingParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *CreateServiceOfferingParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + +func (p *CreateServiceOfferingParams) SetGpucount(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpucount"] = v +} + +func (p *CreateServiceOfferingParams) ResetGpucount() { + if p.p != nil && p.p["gpucount"] != nil { + delete(p.p, "gpucount") + } +} + +func (p *CreateServiceOfferingParams) GetGpucount() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpucount"].(int) + return value, ok +} + +func (p *CreateServiceOfferingParams) SetGpudisplay(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpudisplay"] = v +} + +func (p *CreateServiceOfferingParams) ResetGpudisplay() { + if p.p != nil && p.p["gpudisplay"] != nil { + delete(p.p, "gpudisplay") + } +} + +func (p *CreateServiceOfferingParams) GetGpudisplay() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpudisplay"].(bool) + return value, ok +} + func (p *CreateServiceOfferingParams) SetHosttags(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -825,6 +913,48 @@ func (p *CreateServiceOfferingParams) GetIsvolatile() (bool, bool) { return value, ok } +func (p *CreateServiceOfferingParams) SetLeaseduration(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseduration"] = v +} + +func (p *CreateServiceOfferingParams) ResetLeaseduration() { + if p.p != nil && p.p["leaseduration"] != nil { + delete(p.p, "leaseduration") + } +} + +func (p *CreateServiceOfferingParams) GetLeaseduration() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseduration"].(int) + return value, ok +} + +func (p *CreateServiceOfferingParams) SetLeaseexpiryaction(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseexpiryaction"] = v +} + +func (p *CreateServiceOfferingParams) ResetLeaseexpiryaction() { + if p.p != nil && p.p["leaseexpiryaction"] != nil { + delete(p.p, "leaseexpiryaction") + } +} + +func (p *CreateServiceOfferingParams) GetLeaseexpiryaction() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseexpiryaction"].(string) + return value, ok +} + func (p *CreateServiceOfferingParams) SetLimitcpuuse(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1224,6 +1354,27 @@ func (p *CreateServiceOfferingParams) GetTags() (string, bool) { return value, ok } +func (p *CreateServiceOfferingParams) SetVgpuprofileid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vgpuprofileid"] = v +} + +func (p *CreateServiceOfferingParams) ResetVgpuprofileid() { + if p.p != nil && p.p["vgpuprofileid"] != nil { + delete(p.p, "vgpuprofileid") + } +} + +func (p *CreateServiceOfferingParams) GetVgpuprofileid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vgpuprofileid"].(string) + return value, ok +} + func (p *CreateServiceOfferingParams) SetZoneid(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1302,6 +1453,10 @@ type CreateServiceOfferingResponse struct { Domainid string `json:"domainid"` Dynamicscalingenabled bool `json:"dynamicscalingenabled"` Encryptroot bool `json:"encryptroot"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` + Gpudisplay bool `json:"gpudisplay"` Hasannotations bool `json:"hasannotations"` Hosttags string `json:"hosttags"` Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` @@ -1312,8 +1467,13 @@ type CreateServiceOfferingResponse struct { Isvolatile bool `json:"isvolatile"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` Limitcpuuse bool `json:"limitcpuuse"` + Maxheads int64 `json:"maxheads"` Maxiops int64 `json:"maxiops"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Miniops int64 `json:"miniops"` Name string `json:"name"` @@ -1327,6 +1487,9 @@ type CreateServiceOfferingResponse struct { Storagetags string `json:"storagetags"` Storagetype string `json:"storagetype"` Systemvmtype string `json:"systemvmtype"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vspherestoragepolicy string `json:"vspherestoragepolicy"` Zone string `json:"zone"` Zoneid string `json:"zoneid"` @@ -1453,6 +1616,10 @@ func (p *ListServiceOfferingsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("encryptroot", vv) } + if v, found := p.p["gpuenabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("gpuenabled", vv) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -1501,6 +1668,9 @@ func (p *ListServiceOfferingsParams) toURLValues() url.Values { if v, found := p.p["templateid"]; found { u.Set("templateid", v.(string)) } + if v, found := p.p["vgpuprofileid"]; found { + u.Set("vgpuprofileid", v.(string)) + } if v, found := p.p["virtualmachineid"]; found { u.Set("virtualmachineid", v.(string)) } @@ -1615,6 +1785,27 @@ func (p *ListServiceOfferingsParams) GetEncryptroot() (bool, bool) { return value, ok } +func (p *ListServiceOfferingsParams) SetGpuenabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpuenabled"] = v +} + +func (p *ListServiceOfferingsParams) ResetGpuenabled() { + if p.p != nil && p.p["gpuenabled"] != nil { + delete(p.p, "gpuenabled") + } +} + +func (p *ListServiceOfferingsParams) GetGpuenabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpuenabled"].(bool) + return value, ok +} + func (p *ListServiceOfferingsParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1909,6 +2100,27 @@ func (p *ListServiceOfferingsParams) GetTemplateid() (string, bool) { return value, ok } +func (p *ListServiceOfferingsParams) SetVgpuprofileid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vgpuprofileid"] = v +} + +func (p *ListServiceOfferingsParams) ResetVgpuprofileid() { + if p.p != nil && p.p["vgpuprofileid"] != nil { + delete(p.p, "vgpuprofileid") + } +} + +func (p *ListServiceOfferingsParams) GetVgpuprofileid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vgpuprofileid"].(string) + return value, ok +} + func (p *ListServiceOfferingsParams) SetVirtualmachineid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2090,6 +2302,10 @@ type ServiceOffering struct { Domainid string `json:"domainid"` Dynamicscalingenabled bool `json:"dynamicscalingenabled"` Encryptroot bool `json:"encryptroot"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` + Gpudisplay bool `json:"gpudisplay"` Hasannotations bool `json:"hasannotations"` Hosttags string `json:"hosttags"` Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` @@ -2100,8 +2316,13 @@ type ServiceOffering struct { Isvolatile bool `json:"isvolatile"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` Limitcpuuse bool `json:"limitcpuuse"` + Maxheads int64 `json:"maxheads"` Maxiops int64 `json:"maxiops"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Miniops int64 `json:"miniops"` Name string `json:"name"` @@ -2115,6 +2336,9 @@ type ServiceOffering struct { Storagetags string `json:"storagetags"` Storagetype string `json:"storagetype"` Systemvmtype string `json:"systemvmtype"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vspherestoragepolicy string `json:"vspherestoragepolicy"` Zone string `json:"zone"` Zoneid string `json:"zoneid"` @@ -2135,6 +2359,13 @@ func (p *UpdateServiceOfferingParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } if v, found := p.p["hosttags"]; found { u.Set("hosttags", v.(string)) } @@ -2206,6 +2437,27 @@ func (p *UpdateServiceOfferingParams) GetDomainid() (string, bool) { return value, ok } +func (p *UpdateServiceOfferingParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *UpdateServiceOfferingParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *UpdateServiceOfferingParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + func (p *UpdateServiceOfferingParams) SetHosttags(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2430,6 +2682,10 @@ type UpdateServiceOfferingResponse struct { Domainid string `json:"domainid"` Dynamicscalingenabled bool `json:"dynamicscalingenabled"` Encryptroot bool `json:"encryptroot"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` + Gpudisplay bool `json:"gpudisplay"` Hasannotations bool `json:"hasannotations"` Hosttags string `json:"hosttags"` Hypervisorsnapshotreserve int `json:"hypervisorsnapshotreserve"` @@ -2440,8 +2696,13 @@ type UpdateServiceOfferingResponse struct { Isvolatile bool `json:"isvolatile"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` Limitcpuuse bool `json:"limitcpuuse"` + Maxheads int64 `json:"maxheads"` Maxiops int64 `json:"maxiops"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Miniops int64 `json:"miniops"` Name string `json:"name"` @@ -2455,6 +2716,9 @@ type UpdateServiceOfferingResponse struct { Storagetags string `json:"storagetags"` Storagetype string `json:"storagetype"` Systemvmtype string `json:"systemvmtype"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vspherestoragepolicy string `json:"vspherestoragepolicy"` Zone string `json:"zone"` Zoneid string `json:"zoneid"` diff --git a/cloudstack/SnapshotService.go b/cloudstack/SnapshotService.go index 5c0102d7..b1a148a9 100644 --- a/cloudstack/SnapshotService.go +++ b/cloudstack/SnapshotService.go @@ -149,6 +149,7 @@ func (s *SnapshotService) ArchiveSnapshot(p *ArchiveSnapshotParams) (*ArchiveSna type ArchiveSnapshotResponse struct { Account string `json:"account"` + Chainsize int64 `json:"chainsize"` Created string `json:"created"` Datastoreid string `json:"datastoreid"` Datastorename string `json:"datastorename"` @@ -233,6 +234,14 @@ func (p *CopySnapshotParams) toURLValues() url.Values { if v, found := p.p["sourcezoneid"]; found { u.Set("sourcezoneid", v.(string)) } + if v, found := p.p["storageids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("storageids", vv) + } + if v, found := p.p["usestoragereplication"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("usestoragereplication", vv) + } return u } @@ -320,6 +329,48 @@ func (p *CopySnapshotParams) GetSourcezoneid() (string, bool) { return value, ok } +func (p *CopySnapshotParams) SetStorageids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageids"] = v +} + +func (p *CopySnapshotParams) ResetStorageids() { + if p.p != nil && p.p["storageids"] != nil { + delete(p.p, "storageids") + } +} + +func (p *CopySnapshotParams) GetStorageids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageids"].([]string) + return value, ok +} + +func (p *CopySnapshotParams) SetUsestoragereplication(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usestoragereplication"] = v +} + +func (p *CopySnapshotParams) ResetUsestoragereplication() { + if p.p != nil && p.p["usestoragereplication"] != nil { + delete(p.p, "usestoragereplication") + } +} + +func (p *CopySnapshotParams) GetUsestoragereplication() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usestoragereplication"].(bool) + return value, ok +} + // You should always use this function to get a new CopySnapshotParams instance, // as then you are sure you have configured all required params func (s *SnapshotService) NewCopySnapshotParams(id string) *CopySnapshotParams { @@ -366,6 +417,7 @@ func (s *SnapshotService) CopySnapshot(p *CopySnapshotParams) (*CopySnapshotResp type CopySnapshotResponse struct { Account string `json:"account"` + Chainsize int64 `json:"chainsize"` Created string `json:"created"` Datastoreid string `json:"datastoreid"` Datastorename string `json:"datastorename"` @@ -460,6 +512,10 @@ func (p *CreateSnapshotParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("quiescevm", vv) } + if v, found := p.p["storageids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("storageids", vv) + } if v, found := p.p["tags"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -467,6 +523,10 @@ func (p *CreateSnapshotParams) toURLValues() url.Values { u.Set(fmt.Sprintf("tags[%d].value", i), m[k]) } } + if v, found := p.p["usestoragereplication"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("usestoragereplication", vv) + } if v, found := p.p["volumeid"]; found { u.Set("volumeid", v.(string)) } @@ -624,6 +684,27 @@ func (p *CreateSnapshotParams) GetQuiescevm() (bool, bool) { return value, ok } +func (p *CreateSnapshotParams) SetStorageids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageids"] = v +} + +func (p *CreateSnapshotParams) ResetStorageids() { + if p.p != nil && p.p["storageids"] != nil { + delete(p.p, "storageids") + } +} + +func (p *CreateSnapshotParams) GetStorageids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageids"].([]string) + return value, ok +} + func (p *CreateSnapshotParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -645,6 +726,27 @@ func (p *CreateSnapshotParams) GetTags() (map[string]string, bool) { return value, ok } +func (p *CreateSnapshotParams) SetUsestoragereplication(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usestoragereplication"] = v +} + +func (p *CreateSnapshotParams) ResetUsestoragereplication() { + if p.p != nil && p.p["usestoragereplication"] != nil { + delete(p.p, "usestoragereplication") + } +} + +func (p *CreateSnapshotParams) GetUsestoragereplication() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usestoragereplication"].(bool) + return value, ok +} + func (p *CreateSnapshotParams) SetVolumeid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -733,6 +835,7 @@ func (s *SnapshotService) CreateSnapshot(p *CreateSnapshotParams) (*CreateSnapsh type CreateSnapshotResponse struct { Account string `json:"account"` + Chainsize int64 `json:"chainsize"` Created string `json:"created"` Datastoreid string `json:"datastoreid"` Datastorename string `json:"datastorename"` @@ -926,6 +1029,7 @@ func (s *SnapshotService) CreateSnapshotFromVMSnapshot(p *CreateSnapshotFromVMSn type CreateSnapshotFromVMSnapshotResponse struct { Account string `json:"account"` + Chainsize int64 `json:"chainsize"` Created string `json:"created"` Datastoreid string `json:"datastoreid"` Datastorename string `json:"datastorename"` @@ -1011,6 +1115,10 @@ func (p *CreateSnapshotPolicyParams) toURLValues() url.Values { if v, found := p.p["schedule"]; found { u.Set("schedule", v.(string)) } + if v, found := p.p["storageids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("storageids", vv) + } if v, found := p.p["tags"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -1021,6 +1129,10 @@ func (p *CreateSnapshotPolicyParams) toURLValues() url.Values { if v, found := p.p["timezone"]; found { u.Set("timezone", v.(string)) } + if v, found := p.p["usestoragereplication"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("usestoragereplication", vv) + } if v, found := p.p["volumeid"]; found { u.Set("volumeid", v.(string)) } @@ -1115,6 +1227,27 @@ func (p *CreateSnapshotPolicyParams) GetSchedule() (string, bool) { return value, ok } +func (p *CreateSnapshotPolicyParams) SetStorageids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageids"] = v +} + +func (p *CreateSnapshotPolicyParams) ResetStorageids() { + if p.p != nil && p.p["storageids"] != nil { + delete(p.p, "storageids") + } +} + +func (p *CreateSnapshotPolicyParams) GetStorageids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageids"].([]string) + return value, ok +} + func (p *CreateSnapshotPolicyParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1157,6 +1290,27 @@ func (p *CreateSnapshotPolicyParams) GetTimezone() (string, bool) { return value, ok } +func (p *CreateSnapshotPolicyParams) SetUsestoragereplication(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usestoragereplication"] = v +} + +func (p *CreateSnapshotPolicyParams) ResetUsestoragereplication() { + if p.p != nil && p.p["usestoragereplication"] != nil { + delete(p.p, "usestoragereplication") + } +} + +func (p *CreateSnapshotPolicyParams) GetUsestoragereplication() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usestoragereplication"].(bool) + return value, ok +} + func (p *CreateSnapshotPolicyParams) SetVolumeid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1236,6 +1390,7 @@ type CreateSnapshotPolicyResponse struct { Jobstatus int `json:"jobstatus"` Maxsnaps int `json:"maxsnaps"` Schedule string `json:"schedule"` + Storage []interface{} `json:"storage"` Tags []Tags `json:"tags"` Timezone string `json:"timezone"` Volumeid string `json:"volumeid"` @@ -2107,6 +2262,7 @@ type SnapshotPolicy struct { Jobstatus int `json:"jobstatus"` Maxsnaps int `json:"maxsnaps"` Schedule string `json:"schedule"` + Storage []interface{} `json:"storage"` Tags []Tags `json:"tags"` Timezone string `json:"timezone"` Volumeid string `json:"volumeid"` @@ -2728,6 +2884,7 @@ type ListSnapshotsResponse struct { type Snapshot struct { Account string `json:"account"` + Chainsize int64 `json:"chainsize"` Created string `json:"created"` Datastoreid string `json:"datastoreid"` Datastorename string `json:"datastorename"` @@ -3321,6 +3478,7 @@ func (s *SnapshotService) RevertSnapshot(p *RevertSnapshotParams) (*RevertSnapsh type RevertSnapshotResponse struct { Account string `json:"account"` + Chainsize int64 `json:"chainsize"` Created string `json:"created"` Datastoreid string `json:"datastoreid"` Datastorename string `json:"datastorename"` @@ -3491,6 +3649,9 @@ type RevertToVMSnapshotResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -3512,6 +3673,12 @@ type RevertToVMSnapshotResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -3553,6 +3720,9 @@ type RevertToVMSnapshotResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -3769,6 +3939,7 @@ type UpdateSnapshotPolicyResponse struct { Jobstatus int `json:"jobstatus"` Maxsnaps int `json:"maxsnaps"` Schedule string `json:"schedule"` + Storage []interface{} `json:"storage"` Tags []Tags `json:"tags"` Timezone string `json:"timezone"` Volumeid string `json:"volumeid"` diff --git a/cloudstack/StoragePoolService.go b/cloudstack/StoragePoolService.go index 51509343..ea964ada 100644 --- a/cloudstack/StoragePoolService.go +++ b/cloudstack/StoragePoolService.go @@ -146,6 +146,7 @@ type CancelStorageMaintenanceResponse struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Disksizeused int64 `json:"disksizeused"` @@ -166,6 +167,7 @@ type CancelStorageMaintenanceResponse struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storagecapabilities map[string]string `json:"storagecapabilities"` Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` @@ -393,6 +395,7 @@ type EnableStorageMaintenanceResponse struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Disksizeused int64 `json:"disksizeused"` @@ -413,6 +416,7 @@ type EnableStorageMaintenanceResponse struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storagecapabilities map[string]string `json:"storagecapabilities"` Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` @@ -1053,15 +1057,16 @@ type ListObjectStoragePoolsResponse struct { } type ObjectStoragePool struct { - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Providername string `json:"providername"` - Storagetotal int64 `json:"storagetotal"` - Storageused int64 `json:"storageused"` - Url string `json:"url"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Providername string `json:"providername"` + Storageallocated int64 `json:"storageallocated"` + Storagetotal int64 `json:"storagetotal"` + Storageused int64 `json:"storageused"` + Url string `json:"url"` } type ListStoragePoolObjectsParams struct { @@ -1291,6 +1296,10 @@ func (p *UpdateObjectStoragePoolParams) toURLValues() url.Values { if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["size"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("size", vv) + } if v, found := p.p["url"]; found { u.Set("url", v.(string)) } @@ -1339,6 +1348,27 @@ func (p *UpdateObjectStoragePoolParams) GetName() (string, bool) { return value, ok } +func (p *UpdateObjectStoragePoolParams) SetSize(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["size"] = v +} + +func (p *UpdateObjectStoragePoolParams) ResetSize() { + if p.p != nil && p.p["size"] != nil { + delete(p.p, "size") + } +} + +func (p *UpdateObjectStoragePoolParams) GetSize() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["size"].(int64) + return value, ok +} + func (p *UpdateObjectStoragePoolParams) SetUrl(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1388,15 +1418,16 @@ func (s *StoragePoolService) UpdateObjectStoragePool(p *UpdateObjectStoragePoolP } type UpdateObjectStoragePoolResponse struct { - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Providername string `json:"providername"` - Storagetotal int64 `json:"storagetotal"` - Storageused int64 `json:"storageused"` - Url string `json:"url"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Providername string `json:"providername"` + Storageallocated int64 `json:"storageallocated"` + Storagetotal int64 `json:"storagetotal"` + Storageused int64 `json:"storageused"` + Url string `json:"url"` } type AddObjectStoragePoolParams struct { @@ -1421,6 +1452,10 @@ func (p *AddObjectStoragePoolParams) toURLValues() url.Values { if v, found := p.p["provider"]; found { u.Set("provider", v.(string)) } + if v, found := p.p["size"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("size", vv) + } if v, found := p.p["tags"]; found { u.Set("tags", v.(string)) } @@ -1493,6 +1528,27 @@ func (p *AddObjectStoragePoolParams) GetProvider() (string, bool) { return value, ok } +func (p *AddObjectStoragePoolParams) SetSize(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["size"] = v +} + +func (p *AddObjectStoragePoolParams) ResetSize() { + if p.p != nil && p.p["size"] != nil { + delete(p.p, "size") + } +} + +func (p *AddObjectStoragePoolParams) GetSize() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["size"].(int64) + return value, ok +} + func (p *AddObjectStoragePoolParams) SetTags(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1565,15 +1621,16 @@ func (s *StoragePoolService) AddObjectStoragePool(p *AddObjectStoragePoolParams) } type AddObjectStoragePoolResponse struct { - Hasannotations bool `json:"hasannotations"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Providername string `json:"providername"` - Storagetotal int64 `json:"storagetotal"` - Storageused int64 `json:"storageused"` - Url string `json:"url"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Providername string `json:"providername"` + Storageallocated int64 `json:"storageallocated"` + Storagetotal int64 `json:"storagetotal"` + Storageused int64 `json:"storageused"` + Url string `json:"url"` } type DeleteObjectStoragePoolParams struct { @@ -1717,6 +1774,9 @@ func (p *ListStoragePoolsMetricsParams) toURLValues() url.Values { if v, found := p.p["status"]; found { u.Set("status", v.(string)) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["storagecustomstats"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("storagecustomstats", vv) @@ -1979,6 +2039,27 @@ func (p *ListStoragePoolsMetricsParams) GetStatus() (string, bool) { return value, ok } +func (p *ListStoragePoolsMetricsParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListStoragePoolsMetricsParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListStoragePoolsMetricsParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListStoragePoolsMetricsParams) SetStoragecustomstats(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2138,6 +2219,7 @@ type StoragePoolsMetric struct { Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` Created string `json:"created"` + Details map[string]string `json:"details"` Disksizeallocated int64 `json:"disksizeallocated"` Disksizeallocatedgb string `json:"disksizeallocatedgb"` Disksizetotal int64 `json:"disksizetotal"` @@ -2162,6 +2244,7 @@ type StoragePoolsMetric struct { Provider string `json:"provider"` Scope string `json:"scope"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Storageallocateddisablethreshold bool `json:"storageallocateddisablethreshold"` Storageallocatedthreshold bool `json:"storageallocatedthreshold"` Storagecapabilities map[string]string `json:"storagecapabilities"` diff --git a/cloudstack/TemplateService.go b/cloudstack/TemplateService.go index d2cf6b12..9a1c4906 100644 --- a/cloudstack/TemplateService.go +++ b/cloudstack/TemplateService.go @@ -232,6 +232,9 @@ type CopyTemplateResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -311,6 +314,9 @@ func (p *CreateTemplateParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["bits"]; found { vv := strconv.Itoa(v.(int)) u.Set("bits", vv) @@ -402,6 +408,27 @@ func (p *CreateTemplateParams) GetAccount() (string, bool) { return value, ok } +func (p *CreateTemplateParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *CreateTemplateParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *CreateTemplateParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *CreateTemplateParams) SetBits(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -866,6 +893,9 @@ type CreateTemplateResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -1299,6 +1329,10 @@ func (p *GetUploadParamsForTemplateParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["forcks"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forcks", vv) + } if v, found := p.p["format"]; found { u.Set("format", v.(string)) } @@ -1523,6 +1557,27 @@ func (p *GetUploadParamsForTemplateParams) GetDomainid() (string, bool) { return value, ok } +func (p *GetUploadParamsForTemplateParams) SetForcks(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forcks"] = v +} + +func (p *GetUploadParamsForTemplateParams) ResetForcks() { + if p.p != nil && p.p["forcks"] != nil { + delete(p.p, "forcks") + } +} + +func (p *GetUploadParamsForTemplateParams) GetForcks() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forcks"].(bool) + return value, ok +} + func (p *GetUploadParamsForTemplateParams) SetFormat(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2009,6 +2064,13 @@ func (p *ListTemplatesParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["forcks"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forcks", vv) + } if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } @@ -2022,6 +2084,10 @@ func (p *ListTemplatesParams) toURLValues() url.Values { if v, found := p.p["imagestoreid"]; found { u.Set("imagestoreid", v.(string)) } + if v, found := p.p["isready"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isready", vv) + } if v, found := p.p["isrecursive"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("isrecursive", vv) @@ -2040,6 +2106,9 @@ func (p *ListTemplatesParams) toURLValues() url.Values { if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["oscategoryid"]; found { + u.Set("oscategoryid", v.(string)) + } if v, found := p.p["page"]; found { vv := strconv.Itoa(v.(int)) u.Set("page", vv) @@ -2172,6 +2241,48 @@ func (p *ListTemplatesParams) GetDomainid() (string, bool) { return value, ok } +func (p *ListTemplatesParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *ListTemplatesParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *ListTemplatesParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *ListTemplatesParams) SetForcks(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forcks"] = v +} + +func (p *ListTemplatesParams) ResetForcks() { + if p.p != nil && p.p["forcks"] != nil { + delete(p.p, "forcks") + } +} + +func (p *ListTemplatesParams) GetForcks() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forcks"].(bool) + return value, ok +} + func (p *ListTemplatesParams) SetHypervisor(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2256,6 +2367,27 @@ func (p *ListTemplatesParams) GetImagestoreid() (string, bool) { return value, ok } +func (p *ListTemplatesParams) SetIsready(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isready"] = v +} + +func (p *ListTemplatesParams) ResetIsready() { + if p.p != nil && p.p["isready"] != nil { + delete(p.p, "isready") + } +} + +func (p *ListTemplatesParams) GetIsready() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isready"].(bool) + return value, ok +} + func (p *ListTemplatesParams) SetIsrecursive(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2361,6 +2493,27 @@ func (p *ListTemplatesParams) GetName() (string, bool) { return value, ok } +func (p *ListTemplatesParams) SetOscategoryid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["oscategoryid"] = v +} + +func (p *ListTemplatesParams) ResetOscategoryid() { + if p.p != nil && p.p["oscategoryid"] != nil { + delete(p.p, "oscategoryid") + } +} + +func (p *ListTemplatesParams) GetOscategoryid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["oscategoryid"].(string) + return value, ok +} + func (p *ListTemplatesParams) SetPage(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2747,6 +2900,9 @@ type Template struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -2942,6 +3098,9 @@ type PrepareTemplateResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -3051,6 +3210,19 @@ func (p *RegisterTemplateParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for _, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[0].%s", k), m[k]) + } + } + if v, found := p.p["forcks"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forcks", vv) + } if v, found := p.p["format"]; found { u.Set("format", v.(string)) } @@ -3306,6 +3478,69 @@ func (p *RegisterTemplateParams) GetDomainid() (string, bool) { return value, ok } +func (p *RegisterTemplateParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *RegisterTemplateParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *RegisterTemplateParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *RegisterTemplateParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *RegisterTemplateParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *RegisterTemplateParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + +func (p *RegisterTemplateParams) SetForcks(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forcks"] = v +} + +func (p *RegisterTemplateParams) ResetForcks() { + if p.p != nil && p.p["forcks"] != nil { + delete(p.p, "forcks") + } +} + +func (p *RegisterTemplateParams) GetForcks() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forcks"].(bool) + return value, ok +} + func (p *RegisterTemplateParams) SetFormat(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3736,6 +3971,9 @@ type RegisterTemplate struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -3832,6 +4070,14 @@ func (p *UpdateTemplateParams) toURLValues() url.Values { if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } + if v, found := p.p["forceupdateostype"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forceupdateostype", vv) + } + if v, found := p.p["forcks"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forcks", vv) + } if v, found := p.p["format"]; found { u.Set("format", v.(string)) } @@ -3982,6 +4228,48 @@ func (p *UpdateTemplateParams) GetDisplaytext() (string, bool) { return value, ok } +func (p *UpdateTemplateParams) SetForceupdateostype(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forceupdateostype"] = v +} + +func (p *UpdateTemplateParams) ResetForceupdateostype() { + if p.p != nil && p.p["forceupdateostype"] != nil { + delete(p.p, "forceupdateostype") + } +} + +func (p *UpdateTemplateParams) GetForceupdateostype() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forceupdateostype"].(bool) + return value, ok +} + +func (p *UpdateTemplateParams) SetForcks(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forcks"] = v +} + +func (p *UpdateTemplateParams) ResetForcks() { + if p.p != nil && p.p["forcks"] != nil { + delete(p.p, "forcks") + } +} + +func (p *UpdateTemplateParams) GetForcks() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forcks"].(bool) + return value, ok +} + func (p *UpdateTemplateParams) SetFormat(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4277,6 +4565,9 @@ type UpdateTemplateResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -4924,6 +5215,9 @@ type LinkUserDataToTemplateResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` diff --git a/cloudstack/UserService.go b/cloudstack/UserService.go index 1939ad4f..1b46c0b2 100644 --- a/cloudstack/UserService.go +++ b/cloudstack/UserService.go @@ -1019,6 +1019,9 @@ func (p *ListUsersParams) toURLValues() url.Values { if v, found := p.p["username"]; found { u.Set("username", v.(string)) } + if v, found := p.p["usersource"]; found { + u.Set("usersource", v.(string)) + } return u } @@ -1295,6 +1298,27 @@ func (p *ListUsersParams) GetUsername() (string, bool) { return value, ok } +func (p *ListUsersParams) SetUsersource(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["usersource"] = v +} + +func (p *ListUsersParams) ResetUsersource() { + if p.p != nil && p.p["usersource"] != nil { + delete(p.p, "usersource") + } +} + +func (p *ListUsersParams) GetUsersource() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["usersource"].(string) + return value, ok +} + // You should always use this function to get a new ListUsersParams instance, // as then you are sure you have configured all required params func (s *UserService) NewListUsersParams() *ListUsersParams { @@ -2623,7 +2647,7 @@ func (s *UserService) NewRegisterUserDataParams(name string, userdata string) *R return p } -// Register a new userdata. +// Register a new User Data. func (s *UserService) RegisterUserData(p *RegisterUserDataParams) (*RegisterUserDataResponse, error) { resp, err := s.cs.newPostRequest("registerUserData", p.toURLValues()) if err != nil { diff --git a/cloudstack/VLANService.go b/cloudstack/VLANService.go index 55f4e4ce..68b0a31a 100644 --- a/cloudstack/VLANService.go +++ b/cloudstack/VLANService.go @@ -69,10 +69,6 @@ func (p *CreateVlanIpRangeParams) toURLValues() url.Values { if v, found := p.p["endipv6"]; found { u.Set("endipv6", v.(string)) } - if v, found := p.p["fornsx"]; found { - vv := strconv.FormatBool(v.(bool)) - u.Set("fornsx", vv) - } if v, found := p.p["forsystemvms"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forsystemvms", vv) @@ -105,6 +101,9 @@ func (p *CreateVlanIpRangeParams) toURLValues() url.Values { if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } + if v, found := p.p["provider"]; found { + u.Set("provider", v.(string)) + } if v, found := p.p["startip"]; found { u.Set("startip", v.(string)) } @@ -204,27 +203,6 @@ func (p *CreateVlanIpRangeParams) GetEndipv6() (string, bool) { return value, ok } -func (p *CreateVlanIpRangeParams) SetFornsx(v bool) { - if p.p == nil { - p.p = make(map[string]interface{}) - } - p.p["fornsx"] = v -} - -func (p *CreateVlanIpRangeParams) ResetFornsx() { - if p.p != nil && p.p["fornsx"] != nil { - delete(p.p, "fornsx") - } -} - -func (p *CreateVlanIpRangeParams) GetFornsx() (bool, bool) { - if p.p == nil { - p.p = make(map[string]interface{}) - } - value, ok := p.p["fornsx"].(bool) - return value, ok -} - func (p *CreateVlanIpRangeParams) SetForsystemvms(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -435,6 +413,27 @@ func (p *CreateVlanIpRangeParams) GetProjectid() (string, bool) { return value, ok } +func (p *CreateVlanIpRangeParams) SetProvider(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["provider"] = v +} + +func (p *CreateVlanIpRangeParams) ResetProvider() { + if p.p != nil && p.p["provider"] != nil { + delete(p.p, "provider") + } +} + +func (p *CreateVlanIpRangeParams) GetProvider() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["provider"].(string) + return value, ok +} + func (p *CreateVlanIpRangeParams) SetStartip(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -555,7 +554,6 @@ type CreateVlanIpRangeResponse struct { Domainpath string `json:"domainpath"` Endip string `json:"endip"` Endipv6 string `json:"endipv6"` - Fornsx bool `json:"fornsx"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Gateway string `json:"gateway"` @@ -571,6 +569,7 @@ type CreateVlanIpRangeResponse struct { Podname string `json:"podname"` Project string `json:"project"` Projectid string `json:"projectid"` + Provider string `json:"provider"` Startip string `json:"startip"` Startipv6 string `json:"startipv6"` Vlan string `json:"vlan"` @@ -1574,7 +1573,6 @@ type VlanIpRange struct { Domainpath string `json:"domainpath"` Endip string `json:"endip"` Endipv6 string `json:"endipv6"` - Fornsx bool `json:"fornsx"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Gateway string `json:"gateway"` @@ -1590,6 +1588,7 @@ type VlanIpRange struct { Podname string `json:"podname"` Project string `json:"project"` Projectid string `json:"projectid"` + Provider string `json:"provider"` Startip string `json:"startip"` Startipv6 string `json:"startipv6"` Vlan string `json:"vlan"` @@ -2225,7 +2224,6 @@ type UpdateVlanIpRangeResponse struct { Domainpath string `json:"domainpath"` Endip string `json:"endip"` Endipv6 string `json:"endipv6"` - Fornsx bool `json:"fornsx"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Gateway string `json:"gateway"` @@ -2241,6 +2239,7 @@ type UpdateVlanIpRangeResponse struct { Podname string `json:"podname"` Project string `json:"project"` Projectid string `json:"projectid"` + Provider string `json:"provider"` Startip string `json:"startip"` Startipv6 string `json:"startipv6"` Vlan string `json:"vlan"` diff --git a/cloudstack/VPCService.go b/cloudstack/VPCService.go index ad32996e..d5f67d05 100644 --- a/cloudstack/VPCService.go +++ b/cloudstack/VPCService.go @@ -31,7 +31,7 @@ type VPCServiceIface interface { CreatePrivateGateway(p *CreatePrivateGatewayParams) (*CreatePrivateGatewayResponse, error) NewCreatePrivateGatewayParams(gateway string, ipaddress string, netmask string, vpcid string) *CreatePrivateGatewayParams CreateStaticRoute(p *CreateStaticRouteParams) (*CreateStaticRouteResponse, error) - NewCreateStaticRouteParams(cidr string, gatewayid string) *CreateStaticRouteParams + NewCreateStaticRouteParams(cidr string) *CreateStaticRouteParams CreateVPC(p *CreateVPCParams) (*CreateVPCResponse, error) NewCreateVPCParams(cidr string, displaytext string, name string, vpcofferingid string, zoneid string) *CreateVPCParams CreateVPCOffering(p *CreateVPCOfferingParams) (*CreateVPCOfferingResponse, error) @@ -438,6 +438,12 @@ func (p *CreateStaticRouteParams) toURLValues() url.Values { if v, found := p.p["gatewayid"]; found { u.Set("gatewayid", v.(string)) } + if v, found := p.p["nexthop"]; found { + u.Set("nexthop", v.(string)) + } + if v, found := p.p["vpcid"]; found { + u.Set("vpcid", v.(string)) + } return u } @@ -483,13 +489,54 @@ func (p *CreateStaticRouteParams) GetGatewayid() (string, bool) { return value, ok } +func (p *CreateStaticRouteParams) SetNexthop(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nexthop"] = v +} + +func (p *CreateStaticRouteParams) ResetNexthop() { + if p.p != nil && p.p["nexthop"] != nil { + delete(p.p, "nexthop") + } +} + +func (p *CreateStaticRouteParams) GetNexthop() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nexthop"].(string) + return value, ok +} + +func (p *CreateStaticRouteParams) SetVpcid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vpcid"] = v +} + +func (p *CreateStaticRouteParams) ResetVpcid() { + if p.p != nil && p.p["vpcid"] != nil { + delete(p.p, "vpcid") + } +} + +func (p *CreateStaticRouteParams) GetVpcid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vpcid"].(string) + return value, ok +} + // You should always use this function to get a new CreateStaticRouteParams instance, // as then you are sure you have configured all required params -func (s *VPCService) NewCreateStaticRouteParams(cidr string, gatewayid string) *CreateStaticRouteParams { +func (s *VPCService) NewCreateStaticRouteParams(cidr string) *CreateStaticRouteParams { p := &CreateStaticRouteParams{} p.p = make(map[string]interface{}) p.p["cidr"] = cidr - p.p["gatewayid"] = gatewayid return p } @@ -529,20 +576,22 @@ func (s *VPCService) CreateStaticRoute(p *CreateStaticRouteParams) (*CreateStati } type CreateStaticRouteResponse struct { - Account string `json:"account"` - Cidr string `json:"cidr"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Domainpath string `json:"domainpath"` - Gatewayid string `json:"gatewayid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - State string `json:"state"` - Tags []Tags `json:"tags"` - Vpcid string `json:"vpcid"` + Account string `json:"account"` + Cidr string `json:"cidr"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Nexthop string `json:"nexthop"` + Project string `json:"project"` + Projectid string `json:"projectid"` + State string `json:"state"` + Tags []Tags `json:"tags"` + Vpcgatewayid string `json:"vpcgatewayid"` + Vpcgatewayip string `json:"vpcgatewayip"` + Vpcid string `json:"vpcid"` } type CreateVPCParams struct { @@ -614,6 +663,10 @@ func (p *CreateVPCParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("start", vv) } + if v, found := p.p["userouteripresolver"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("userouteripresolver", vv) + } if v, found := p.p["vpcofferingid"]; found { u.Set("vpcofferingid", v.(string)) } @@ -1001,6 +1054,27 @@ func (p *CreateVPCParams) GetStart() (bool, bool) { return value, ok } +func (p *CreateVPCParams) SetUserouteripresolver(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userouteripresolver"] = v +} + +func (p *CreateVPCParams) ResetUserouteripresolver() { + if p.p != nil && p.p["userouteripresolver"] != nil { + delete(p.p, "userouteripresolver") + } +} + +func (p *CreateVPCParams) GetUserouteripresolver() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userouteripresolver"].(bool) + return value, ok +} + func (p *CreateVPCParams) SetVpcofferingid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1193,6 +1267,9 @@ func (p *CreateVPCOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("nsxsupportlb", vv) } + if v, found := p.p["provider"]; found { + u.Set("provider", v.(string)) + } if v, found := p.p["routingmode"]; found { u.Set("routingmode", v.(string)) } @@ -1396,6 +1473,27 @@ func (p *CreateVPCOfferingParams) GetNsxsupportlb() (bool, bool) { return value, ok } +func (p *CreateVPCOfferingParams) SetProvider(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["provider"] = v +} + +func (p *CreateVPCOfferingParams) ResetProvider() { + if p.p != nil && p.p["provider"] != nil { + delete(p.p, "provider") + } +} + +func (p *CreateVPCOfferingParams) GetProvider() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["provider"].(string) + return value, ok +} + func (p *CreateVPCOfferingParams) SetRoutingmode(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2772,20 +2870,22 @@ type ListStaticRoutesResponse struct { } type StaticRoute struct { - Account string `json:"account"` - Cidr string `json:"cidr"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Domainpath string `json:"domainpath"` - Gatewayid string `json:"gatewayid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - State string `json:"state"` - Tags []Tags `json:"tags"` - Vpcid string `json:"vpcid"` + Account string `json:"account"` + Cidr string `json:"cidr"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Nexthop string `json:"nexthop"` + Project string `json:"project"` + Projectid string `json:"projectid"` + State string `json:"state"` + Tags []Tags `json:"tags"` + Vpcgatewayid string `json:"vpcgatewayid"` + Vpcgatewayip string `json:"vpcgatewayip"` + Vpcid string `json:"vpcid"` } type ListVPCOfferingsParams struct { diff --git a/cloudstack/VPCService_mock.go b/cloudstack/VPCService_mock.go index c5513a07..7431292f 100644 --- a/cloudstack/VPCService_mock.go +++ b/cloudstack/VPCService_mock.go @@ -436,17 +436,17 @@ func (mr *MockVPCServiceIfaceMockRecorder) NewCreatePrivateGatewayParams(gateway } // NewCreateStaticRouteParams mocks base method. -func (m *MockVPCServiceIface) NewCreateStaticRouteParams(cidr, gatewayid string) *CreateStaticRouteParams { +func (m *MockVPCServiceIface) NewCreateStaticRouteParams(cidr string) *CreateStaticRouteParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreateStaticRouteParams", cidr, gatewayid) + ret := m.ctrl.Call(m, "NewCreateStaticRouteParams", cidr) ret0, _ := ret[0].(*CreateStaticRouteParams) return ret0 } // NewCreateStaticRouteParams indicates an expected call of NewCreateStaticRouteParams. -func (mr *MockVPCServiceIfaceMockRecorder) NewCreateStaticRouteParams(cidr, gatewayid any) *gomock.Call { +func (mr *MockVPCServiceIfaceMockRecorder) NewCreateStaticRouteParams(cidr any) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateStaticRouteParams", reflect.TypeOf((*MockVPCServiceIface)(nil).NewCreateStaticRouteParams), cidr, gatewayid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateStaticRouteParams", reflect.TypeOf((*MockVPCServiceIface)(nil).NewCreateStaticRouteParams), cidr) } // NewCreateVPCOfferingParams mocks base method. diff --git a/cloudstack/VPNService.go b/cloudstack/VPNService.go index 5a77d5c4..785c1cd9 100644 --- a/cloudstack/VPNService.go +++ b/cloudstack/VPNService.go @@ -1139,6 +1139,9 @@ func (p *CreateVpnGatewayParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("fordisplay", vv) } + if v, found := p.p["ipaddressid"]; found { + u.Set("ipaddressid", v.(string)) + } if v, found := p.p["vpcid"]; found { u.Set("vpcid", v.(string)) } @@ -1166,6 +1169,27 @@ func (p *CreateVpnGatewayParams) GetFordisplay() (bool, bool) { return value, ok } +func (p *CreateVpnGatewayParams) SetIpaddressid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ipaddressid"] = v +} + +func (p *CreateVpnGatewayParams) ResetIpaddressid() { + if p.p != nil && p.p["ipaddressid"] != nil { + delete(p.p, "ipaddressid") + } +} + +func (p *CreateVpnGatewayParams) GetIpaddressid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ipaddressid"].(string) + return value, ok +} + func (p *CreateVpnGatewayParams) SetVpcid(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 8a9166cc..27c5eb91 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -37,7 +37,7 @@ type VirtualMachineServiceIface interface { CleanVMReservations(p *CleanVMReservationsParams) (*CleanVMReservationsResponse, error) NewCleanVMReservationsParams() *CleanVMReservationsParams DeployVirtualMachine(p *DeployVirtualMachineParams) (*DeployVirtualMachineResponse, error) - NewDeployVirtualMachineParams(serviceofferingid string, templateid string, zoneid string) *DeployVirtualMachineParams + NewDeployVirtualMachineParams(serviceofferingid string, zoneid string) *DeployVirtualMachineParams DestroyVirtualMachine(p *DestroyVirtualMachineParams) (*DestroyVirtualMachineResponse, error) NewDestroyVirtualMachineParams(id string) *DestroyVirtualMachineParams ExpungeVirtualMachine(p *ExpungeVirtualMachineParams) (*ExpungeVirtualMachineResponse, error) @@ -315,6 +315,9 @@ type AddNicToVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -336,6 +339,12 @@ type AddNicToVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -377,6 +386,9 @@ type AddNicToVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -666,6 +678,9 @@ type AssignVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -687,6 +702,12 @@ type AssignVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -728,6 +749,9 @@ type AssignVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -1047,6 +1071,9 @@ type ChangeServiceForVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -1068,6 +1095,12 @@ type ChangeServiceForVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -1109,6 +1142,9 @@ type ChangeServiceForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -1292,6 +1328,13 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { u.Set(fmt.Sprintf("datadiskofferinglist[%d].diskOffering", i), m[k]) } } + if v, found := p.p["datadisksdetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("datadisksdetails[%d].key", i), k) + u.Set(fmt.Sprintf("datadisksdetails[%d].value", i), m[k]) + } + } if v, found := p.p["deploymentplanner"]; found { u.Set("deploymentplanner", v.(string)) } @@ -1326,6 +1369,13 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("dynamicscalingenabled", vv) } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } if v, found := p.p["extraconfig"]; found { u.Set("extraconfig", v.(string)) } @@ -1369,6 +1419,13 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("keypairs", vv) } + if v, found := p.p["leaseduration"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("leaseduration", vv) + } + if v, found := p.p["leaseexpiryaction"]; found { + u.Set("leaseexpiryaction", v.(string)) + } if v, found := p.p["macaddress"]; found { u.Set("macaddress", v.(string)) } @@ -1433,6 +1490,9 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { vv := strconv.FormatInt(v.(int64), 10) u.Set("size", vv) } + if v, found := p.p["snapshotid"]; found { + u.Set("snapshotid", v.(string)) + } if v, found := p.p["startvm"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("startvm", vv) @@ -1453,6 +1513,9 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["userdataid"]; found { u.Set("userdataid", v.(string)) } + if v, found := p.p["volumeid"]; found { + u.Set("volumeid", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -1669,6 +1732,27 @@ func (p *DeployVirtualMachineParams) GetDatadiskofferinglist() (map[string]strin return value, ok } +func (p *DeployVirtualMachineParams) SetDatadisksdetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["datadisksdetails"] = v +} + +func (p *DeployVirtualMachineParams) ResetDatadisksdetails() { + if p.p != nil && p.p["datadisksdetails"] != nil { + delete(p.p, "datadisksdetails") + } +} + +func (p *DeployVirtualMachineParams) GetDatadisksdetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["datadisksdetails"].(map[string]string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetDeploymentplanner(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1851,6 +1935,27 @@ func (p *DeployVirtualMachineParams) GetDynamicscalingenabled() (bool, bool) { return value, ok } +func (p *DeployVirtualMachineParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *DeployVirtualMachineParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *DeployVirtualMachineParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetExtraconfig(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2117,6 +2222,48 @@ func (p *DeployVirtualMachineParams) GetKeypairs() ([]string, bool) { return value, ok } +func (p *DeployVirtualMachineParams) SetLeaseduration(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseduration"] = v +} + +func (p *DeployVirtualMachineParams) ResetLeaseduration() { + if p.p != nil && p.p["leaseduration"] != nil { + delete(p.p, "leaseduration") + } +} + +func (p *DeployVirtualMachineParams) GetLeaseduration() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseduration"].(int) + return value, ok +} + +func (p *DeployVirtualMachineParams) SetLeaseexpiryaction(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseexpiryaction"] = v +} + +func (p *DeployVirtualMachineParams) ResetLeaseexpiryaction() { + if p.p != nil && p.p["leaseexpiryaction"] != nil { + delete(p.p, "leaseexpiryaction") + } +} + +func (p *DeployVirtualMachineParams) GetLeaseexpiryaction() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseexpiryaction"].(string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetMacaddress(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2467,6 +2614,27 @@ func (p *DeployVirtualMachineParams) GetSize() (int64, bool) { return value, ok } +func (p *DeployVirtualMachineParams) SetSnapshotid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["snapshotid"] = v +} + +func (p *DeployVirtualMachineParams) ResetSnapshotid() { + if p.p != nil && p.p["snapshotid"] != nil { + delete(p.p, "snapshotid") + } +} + +func (p *DeployVirtualMachineParams) GetSnapshotid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["snapshotid"].(string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetStartvm(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2572,6 +2740,27 @@ func (p *DeployVirtualMachineParams) GetUserdataid() (string, bool) { return value, ok } +func (p *DeployVirtualMachineParams) SetVolumeid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["volumeid"] = v +} + +func (p *DeployVirtualMachineParams) ResetVolumeid() { + if p.p != nil && p.p["volumeid"] != nil { + delete(p.p, "volumeid") + } +} + +func (p *DeployVirtualMachineParams) GetVolumeid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["volumeid"].(string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2595,11 +2784,10 @@ func (p *DeployVirtualMachineParams) GetZoneid() (string, bool) { // You should always use this function to get a new DeployVirtualMachineParams instance, // as then you are sure you have configured all required params -func (s *VirtualMachineService) NewDeployVirtualMachineParams(serviceofferingid string, templateid string, zoneid string) *DeployVirtualMachineParams { +func (s *VirtualMachineService) NewDeployVirtualMachineParams(serviceofferingid string, zoneid string) *DeployVirtualMachineParams { p := &DeployVirtualMachineParams{} p.p = make(map[string]interface{}) p.p["serviceofferingid"] = serviceofferingid - p.p["templateid"] = templateid p.p["zoneid"] = zoneid return p } @@ -2667,6 +2855,9 @@ type DeployVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -2688,6 +2879,12 @@ type DeployVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -2729,6 +2926,9 @@ type DeployVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -2966,6 +3166,9 @@ type DestroyVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -2987,6 +3190,12 @@ type DestroyVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -3028,6 +3237,9 @@ type DestroyVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -3297,10 +3509,17 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } if v, found := p.p["forvirtualnetwork"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forvirtualnetwork", vv) } + if v, found := p.p["gpuenabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("gpuenabled", vv) + } if v, found := p.p["groupid"]; found { u.Set("groupid", v.(string)) } @@ -3338,6 +3557,10 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } + if v, found := p.p["leased"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("leased", vv) + } if v, found := p.p["listall"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("listall", vv) @@ -3621,6 +3844,27 @@ func (p *ListVirtualMachinesParams) GetDomainid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *ListVirtualMachinesParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *ListVirtualMachinesParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + func (p *ListVirtualMachinesParams) SetForvirtualnetwork(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3642,6 +3886,27 @@ func (p *ListVirtualMachinesParams) GetForvirtualnetwork() (bool, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetGpuenabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpuenabled"] = v +} + +func (p *ListVirtualMachinesParams) ResetGpuenabled() { + if p.p != nil && p.p["gpuenabled"] != nil { + delete(p.p, "gpuenabled") + } +} + +func (p *ListVirtualMachinesParams) GetGpuenabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpuenabled"].(bool) + return value, ok +} + func (p *ListVirtualMachinesParams) SetGroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3873,6 +4138,27 @@ func (p *ListVirtualMachinesParams) GetKeyword() (string, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetLeased(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leased"] = v +} + +func (p *ListVirtualMachinesParams) ResetLeased() { + if p.p != nil && p.p["leased"] != nil { + delete(p.p, "leased") + } +} + +func (p *ListVirtualMachinesParams) GetLeased() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leased"].(bool) + return value, ok +} + func (p *ListVirtualMachinesParams) SetListall(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4432,6 +4718,9 @@ type VirtualMachine struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -4453,6 +4742,12 @@ type VirtualMachine struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -4494,6 +4789,9 @@ type VirtualMachine struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -4615,10 +4913,17 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } if v, found := p.p["forvirtualnetwork"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forvirtualnetwork", vv) } + if v, found := p.p["gpuenabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("gpuenabled", vv) + } if v, found := p.p["groupid"]; found { u.Set("groupid", v.(string)) } @@ -4656,6 +4961,10 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } + if v, found := p.p["leased"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("leased", vv) + } if v, found := p.p["listall"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("listall", vv) @@ -4939,6 +5248,27 @@ func (p *ListVirtualMachinesMetricsParams) GetDomainid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *ListVirtualMachinesMetricsParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *ListVirtualMachinesMetricsParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetForvirtualnetwork(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4960,6 +5290,27 @@ func (p *ListVirtualMachinesMetricsParams) GetForvirtualnetwork() (bool, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetGpuenabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpuenabled"] = v +} + +func (p *ListVirtualMachinesMetricsParams) ResetGpuenabled() { + if p.p != nil && p.p["gpuenabled"] != nil { + delete(p.p, "gpuenabled") + } +} + +func (p *ListVirtualMachinesMetricsParams) GetGpuenabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpuenabled"].(bool) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetGroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5191,6 +5542,27 @@ func (p *ListVirtualMachinesMetricsParams) GetKeyword() (string, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetLeased(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leased"] = v +} + +func (p *ListVirtualMachinesMetricsParams) ResetLeased() { + if p.p != nil && p.p["leased"] != nil { + delete(p.p, "leased") + } +} + +func (p *ListVirtualMachinesMetricsParams) GetLeased() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leased"].(bool) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetListall(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5754,6 +6126,9 @@ type VirtualMachinesMetric struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -5775,6 +6150,12 @@ type VirtualMachinesMetric struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -5819,6 +6200,9 @@ type VirtualMachinesMetric struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -6351,6 +6735,9 @@ type MigrateVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -6372,6 +6759,12 @@ type MigrateVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -6413,6 +6806,9 @@ type MigrateVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -6692,6 +7088,9 @@ type MigrateVirtualMachineWithVolumeResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -6713,6 +7112,12 @@ type MigrateVirtualMachineWithVolumeResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -6754,6 +7159,9 @@ type MigrateVirtualMachineWithVolumeResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -6991,6 +7399,9 @@ type RebootVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -7012,6 +7423,12 @@ type RebootVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -7053,6 +7470,9 @@ type RebootVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -7220,6 +7640,9 @@ type RecoverVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -7241,6 +7664,12 @@ type RecoverVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -7282,6 +7711,9 @@ type RecoverVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -7494,6 +7926,9 @@ type RemoveNicFromVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -7515,6 +7950,12 @@ type RemoveNicFromVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -7556,6 +7997,9 @@ type RemoveNicFromVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -7767,6 +8211,9 @@ type ResetPasswordForVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -7788,6 +8235,12 @@ type ResetPasswordForVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -7829,6 +8282,9 @@ type ResetPasswordForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -8144,6 +8600,9 @@ type ResetUserDataForVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -8165,6 +8624,12 @@ type ResetUserDataForVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -8206,6 +8671,9 @@ type ResetUserDataForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -8518,6 +8986,9 @@ type RestoreVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -8539,6 +9010,12 @@ type RestoreVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -8580,6 +9057,9 @@ type RestoreVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -9147,6 +9627,9 @@ type StartVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -9168,6 +9651,12 @@ type StartVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -9209,6 +9698,9 @@ type StartVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -9421,6 +9913,9 @@ type StopVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -9442,6 +9937,12 @@ type StopVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -9483,6 +9984,9 @@ type StopVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -9695,6 +10199,9 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -9716,6 +10223,12 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -9757,6 +10270,9 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -9897,6 +10413,13 @@ func (p *UpdateVirtualMachineParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("isdynamicallyscalable", vv) } + if v, found := p.p["leaseduration"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("leaseduration", vv) + } + if v, found := p.p["leaseexpiryaction"]; found { + u.Set("leaseexpiryaction", v.(string)) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -10214,6 +10737,48 @@ func (p *UpdateVirtualMachineParams) GetIsdynamicallyscalable() (bool, bool) { return value, ok } +func (p *UpdateVirtualMachineParams) SetLeaseduration(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseduration"] = v +} + +func (p *UpdateVirtualMachineParams) ResetLeaseduration() { + if p.p != nil && p.p["leaseduration"] != nil { + delete(p.p, "leaseduration") + } +} + +func (p *UpdateVirtualMachineParams) GetLeaseduration() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseduration"].(int) + return value, ok +} + +func (p *UpdateVirtualMachineParams) SetLeaseexpiryaction(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseexpiryaction"] = v +} + +func (p *UpdateVirtualMachineParams) ResetLeaseexpiryaction() { + if p.p != nil && p.p["leaseexpiryaction"] != nil { + delete(p.p, "leaseexpiryaction") + } +} + +func (p *UpdateVirtualMachineParams) GetLeaseexpiryaction() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseexpiryaction"].(string) + return value, ok +} + func (p *UpdateVirtualMachineParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -10413,6 +10978,9 @@ type UpdateVirtualMachineResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -10434,6 +11002,12 @@ type UpdateVirtualMachineResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -10475,6 +11049,9 @@ type UpdateVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -11858,6 +12435,9 @@ type ImportVmResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -11879,6 +12459,12 @@ type ImportVmResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -11920,6 +12506,9 @@ type ImportVmResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -12747,6 +13336,9 @@ type ImportUnmanagedInstanceResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -12768,6 +13360,12 @@ type ImportUnmanagedInstanceResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -12809,6 +13407,9 @@ type ImportUnmanagedInstanceResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` diff --git a/cloudstack/VirtualMachineService_mock.go b/cloudstack/VirtualMachineService_mock.go index 75c6e86c..bc2f2b38 100644 --- a/cloudstack/VirtualMachineService_mock.go +++ b/cloudstack/VirtualMachineService_mock.go @@ -653,17 +653,17 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewDeleteVMScheduleParams( } // NewDeployVirtualMachineParams mocks base method. -func (m *MockVirtualMachineServiceIface) NewDeployVirtualMachineParams(serviceofferingid, templateid, zoneid string) *DeployVirtualMachineParams { +func (m *MockVirtualMachineServiceIface) NewDeployVirtualMachineParams(serviceofferingid, zoneid string) *DeployVirtualMachineParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewDeployVirtualMachineParams", serviceofferingid, templateid, zoneid) + ret := m.ctrl.Call(m, "NewDeployVirtualMachineParams", serviceofferingid, zoneid) ret0, _ := ret[0].(*DeployVirtualMachineParams) return ret0 } // NewDeployVirtualMachineParams indicates an expected call of NewDeployVirtualMachineParams. -func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewDeployVirtualMachineParams(serviceofferingid, templateid, zoneid any) *gomock.Call { +func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewDeployVirtualMachineParams(serviceofferingid, zoneid any) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeployVirtualMachineParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewDeployVirtualMachineParams), serviceofferingid, templateid, zoneid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeployVirtualMachineParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewDeployVirtualMachineParams), serviceofferingid, zoneid) } // NewDestroyVirtualMachineParams mocks base method. diff --git a/cloudstack/VirtualNetworkFunctionsService.go b/cloudstack/VirtualNetworkFunctionsService.go index 9e73da66..ab348386 100644 --- a/cloudstack/VirtualNetworkFunctionsService.go +++ b/cloudstack/VirtualNetworkFunctionsService.go @@ -31,7 +31,7 @@ type VirtualNetworkFunctionsServiceIface interface { DeleteVnfTemplate(p *DeleteVnfTemplateParams) (*DeleteVnfTemplateResponse, error) NewDeleteVnfTemplateParams(id string) *DeleteVnfTemplateParams DeployVnfAppliance(p *DeployVnfApplianceParams) (*DeployVnfApplianceResponse, error) - NewDeployVnfApplianceParams(serviceofferingid string, templateid string, zoneid string) *DeployVnfApplianceParams + NewDeployVnfApplianceParams(serviceofferingid string, zoneid string) *DeployVnfApplianceParams ListVnfAppliances(p *ListVnfAppliancesParams) (*ListVnfAppliancesResponse, error) NewListVnfAppliancesParams() *ListVnfAppliancesParams GetVnfApplianceID(name string, opts ...OptionFunc) (string, int, error) @@ -248,6 +248,13 @@ func (p *DeployVnfApplianceParams) toURLValues() url.Values { u.Set(fmt.Sprintf("datadiskofferinglist[%d].diskOffering", i), m[k]) } } + if v, found := p.p["datadisksdetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("datadisksdetails[%d].key", i), k) + u.Set(fmt.Sprintf("datadisksdetails[%d].value", i), m[k]) + } + } if v, found := p.p["deploymentplanner"]; found { u.Set("deploymentplanner", v.(string)) } @@ -281,6 +288,13 @@ func (p *DeployVnfApplianceParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("dynamicscalingenabled", vv) } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } if v, found := p.p["extraconfig"]; found { u.Set("extraconfig", v.(string)) } @@ -323,6 +337,13 @@ func (p *DeployVnfApplianceParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("keypairs", vv) } + if v, found := p.p["leaseduration"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("leaseduration", vv) + } + if v, found := p.p["leaseexpiryaction"]; found { + u.Set("leaseexpiryaction", v.(string)) + } if v, found := p.p["macaddress"]; found { u.Set("macaddress", v.(string)) } @@ -383,6 +404,9 @@ func (p *DeployVnfApplianceParams) toURLValues() url.Values { vv := strconv.FormatInt(v.(int64), 10) u.Set("size", vv) } + if v, found := p.p["snapshotid"]; found { + u.Set("snapshotid", v.(string)) + } if v, found := p.p["startvm"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("startvm", vv) @@ -411,6 +435,9 @@ func (p *DeployVnfApplianceParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("vnfconfiguremanagement", vv) } + if v, found := p.p["volumeid"]; found { + u.Set("volumeid", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -606,6 +633,27 @@ func (p *DeployVnfApplianceParams) GetDatadiskofferinglist() (map[string]string, return value, ok } +func (p *DeployVnfApplianceParams) SetDatadisksdetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["datadisksdetails"] = v +} + +func (p *DeployVnfApplianceParams) ResetDatadisksdetails() { + if p.p != nil && p.p["datadisksdetails"] != nil { + delete(p.p, "datadisksdetails") + } +} + +func (p *DeployVnfApplianceParams) GetDatadisksdetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["datadisksdetails"].(map[string]string) + return value, ok +} + func (p *DeployVnfApplianceParams) SetDeploymentplanner(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -774,6 +822,27 @@ func (p *DeployVnfApplianceParams) GetDynamicscalingenabled() (bool, bool) { return value, ok } +func (p *DeployVnfApplianceParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *DeployVnfApplianceParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *DeployVnfApplianceParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + func (p *DeployVnfApplianceParams) SetExtraconfig(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1026,6 +1095,48 @@ func (p *DeployVnfApplianceParams) GetKeypairs() ([]string, bool) { return value, ok } +func (p *DeployVnfApplianceParams) SetLeaseduration(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseduration"] = v +} + +func (p *DeployVnfApplianceParams) ResetLeaseduration() { + if p.p != nil && p.p["leaseduration"] != nil { + delete(p.p, "leaseduration") + } +} + +func (p *DeployVnfApplianceParams) GetLeaseduration() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseduration"].(int) + return value, ok +} + +func (p *DeployVnfApplianceParams) SetLeaseexpiryaction(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseexpiryaction"] = v +} + +func (p *DeployVnfApplianceParams) ResetLeaseexpiryaction() { + if p.p != nil && p.p["leaseexpiryaction"] != nil { + delete(p.p, "leaseexpiryaction") + } +} + +func (p *DeployVnfApplianceParams) GetLeaseexpiryaction() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseexpiryaction"].(string) + return value, ok +} + func (p *DeployVnfApplianceParams) SetMacaddress(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1341,6 +1452,27 @@ func (p *DeployVnfApplianceParams) GetSize() (int64, bool) { return value, ok } +func (p *DeployVnfApplianceParams) SetSnapshotid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["snapshotid"] = v +} + +func (p *DeployVnfApplianceParams) ResetSnapshotid() { + if p.p != nil && p.p["snapshotid"] != nil { + delete(p.p, "snapshotid") + } +} + +func (p *DeployVnfApplianceParams) GetSnapshotid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["snapshotid"].(string) + return value, ok +} + func (p *DeployVnfApplianceParams) SetStartvm(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1488,6 +1620,27 @@ func (p *DeployVnfApplianceParams) GetVnfconfiguremanagement() (bool, bool) { return value, ok } +func (p *DeployVnfApplianceParams) SetVolumeid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["volumeid"] = v +} + +func (p *DeployVnfApplianceParams) ResetVolumeid() { + if p.p != nil && p.p["volumeid"] != nil { + delete(p.p, "volumeid") + } +} + +func (p *DeployVnfApplianceParams) GetVolumeid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["volumeid"].(string) + return value, ok +} + func (p *DeployVnfApplianceParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1511,11 +1664,10 @@ func (p *DeployVnfApplianceParams) GetZoneid() (string, bool) { // You should always use this function to get a new DeployVnfApplianceParams instance, // as then you are sure you have configured all required params -func (s *VirtualNetworkFunctionsService) NewDeployVnfApplianceParams(serviceofferingid string, templateid string, zoneid string) *DeployVnfApplianceParams { +func (s *VirtualNetworkFunctionsService) NewDeployVnfApplianceParams(serviceofferingid string, zoneid string) *DeployVnfApplianceParams { p := &DeployVnfApplianceParams{} p.p = make(map[string]interface{}) p.p["serviceofferingid"] = serviceofferingid - p.p["templateid"] = templateid p.p["zoneid"] = zoneid return p } @@ -1583,6 +1735,9 @@ type DeployVnfApplianceResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -1604,6 +1759,12 @@ type DeployVnfApplianceResponse struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -1645,6 +1806,9 @@ type DeployVnfApplianceResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -1763,10 +1927,17 @@ func (p *ListVnfAppliancesParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } if v, found := p.p["forvirtualnetwork"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forvirtualnetwork", vv) } + if v, found := p.p["gpuenabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("gpuenabled", vv) + } if v, found := p.p["groupid"]; found { u.Set("groupid", v.(string)) } @@ -1801,6 +1972,10 @@ func (p *ListVnfAppliancesParams) toURLValues() url.Values { if v, found := p.p["keyword"]; found { u.Set("keyword", v.(string)) } + if v, found := p.p["leased"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("leased", vv) + } if v, found := p.p["listall"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("listall", vv) @@ -2057,6 +2232,27 @@ func (p *ListVnfAppliancesParams) GetDomainid() (string, bool) { return value, ok } +func (p *ListVnfAppliancesParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *ListVnfAppliancesParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *ListVnfAppliancesParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + func (p *ListVnfAppliancesParams) SetForvirtualnetwork(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2078,6 +2274,27 @@ func (p *ListVnfAppliancesParams) GetForvirtualnetwork() (bool, bool) { return value, ok } +func (p *ListVnfAppliancesParams) SetGpuenabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpuenabled"] = v +} + +func (p *ListVnfAppliancesParams) ResetGpuenabled() { + if p.p != nil && p.p["gpuenabled"] != nil { + delete(p.p, "gpuenabled") + } +} + +func (p *ListVnfAppliancesParams) GetGpuenabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpuenabled"].(bool) + return value, ok +} + func (p *ListVnfAppliancesParams) SetGroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2288,6 +2505,27 @@ func (p *ListVnfAppliancesParams) GetKeyword() (string, bool) { return value, ok } +func (p *ListVnfAppliancesParams) SetLeased(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leased"] = v +} + +func (p *ListVnfAppliancesParams) ResetLeased() { + if p.p != nil && p.p["leased"] != nil { + delete(p.p, "leased") + } +} + +func (p *ListVnfAppliancesParams) GetLeased() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leased"].(bool) + return value, ok +} + func (p *ListVnfAppliancesParams) SetListall(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2805,6 +3043,9 @@ type VnfAppliance struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` Group string `json:"group"` Groupid string `json:"groupid"` Guestosid string `json:"guestosid"` @@ -2826,6 +3067,12 @@ type VnfAppliance struct { Jobstatus int `json:"jobstatus"` Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` Memorykbs int64 `json:"memorykbs"` @@ -2867,6 +3114,9 @@ type VnfAppliance struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` @@ -2968,6 +3218,13 @@ func (p *ListVnfTemplatesParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["forcks"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forcks", vv) + } if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } @@ -2978,6 +3235,10 @@ func (p *ListVnfTemplatesParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("ids", vv) } + if v, found := p.p["isready"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isready", vv) + } if v, found := p.p["isrecursive"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("isrecursive", vv) @@ -2996,6 +3257,9 @@ func (p *ListVnfTemplatesParams) toURLValues() url.Values { if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["oscategoryid"]; found { + u.Set("oscategoryid", v.(string)) + } if v, found := p.p["page"]; found { vv := strconv.Itoa(v.(int)) u.Set("page", vv) @@ -3125,6 +3389,48 @@ func (p *ListVnfTemplatesParams) GetDomainid() (string, bool) { return value, ok } +func (p *ListVnfTemplatesParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *ListVnfTemplatesParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *ListVnfTemplatesParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *ListVnfTemplatesParams) SetForcks(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forcks"] = v +} + +func (p *ListVnfTemplatesParams) ResetForcks() { + if p.p != nil && p.p["forcks"] != nil { + delete(p.p, "forcks") + } +} + +func (p *ListVnfTemplatesParams) GetForcks() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forcks"].(bool) + return value, ok +} + func (p *ListVnfTemplatesParams) SetHypervisor(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3188,6 +3494,27 @@ func (p *ListVnfTemplatesParams) GetIds() ([]string, bool) { return value, ok } +func (p *ListVnfTemplatesParams) SetIsready(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isready"] = v +} + +func (p *ListVnfTemplatesParams) ResetIsready() { + if p.p != nil && p.p["isready"] != nil { + delete(p.p, "isready") + } +} + +func (p *ListVnfTemplatesParams) GetIsready() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isready"].(bool) + return value, ok +} + func (p *ListVnfTemplatesParams) SetIsrecursive(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3293,6 +3620,27 @@ func (p *ListVnfTemplatesParams) GetName() (string, bool) { return value, ok } +func (p *ListVnfTemplatesParams) SetOscategoryid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["oscategoryid"] = v +} + +func (p *ListVnfTemplatesParams) ResetOscategoryid() { + if p.p != nil && p.p["oscategoryid"] != nil { + delete(p.p, "oscategoryid") + } +} + +func (p *ListVnfTemplatesParams) GetOscategoryid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["oscategoryid"].(string) + return value, ok +} + func (p *ListVnfTemplatesParams) SetPage(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3657,6 +4005,9 @@ type VnfTemplate struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -3766,6 +4117,20 @@ func (p *RegisterVnfTemplateParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } + if v, found := p.p["forcks"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forcks", vv) + } if v, found := p.p["format"]; found { u.Set("format", v.(string)) } @@ -4035,6 +4400,69 @@ func (p *RegisterVnfTemplateParams) GetDomainid() (string, bool) { return value, ok } +func (p *RegisterVnfTemplateParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *RegisterVnfTemplateParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *RegisterVnfTemplateParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *RegisterVnfTemplateParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *RegisterVnfTemplateParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *RegisterVnfTemplateParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + +func (p *RegisterVnfTemplateParams) SetForcks(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forcks"] = v +} + +func (p *RegisterVnfTemplateParams) ResetForcks() { + if p.p != nil && p.p["forcks"] != nil { + delete(p.p, "forcks") + } +} + +func (p *RegisterVnfTemplateParams) GetForcks() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forcks"].(bool) + return value, ok +} + func (p *RegisterVnfTemplateParams) SetFormat(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4501,6 +4929,9 @@ type RegisterVnfTemplateResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` @@ -4605,6 +5036,14 @@ func (p *UpdateVnfTemplateParams) toURLValues() url.Values { if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } + if v, found := p.p["forceupdateostype"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forceupdateostype", vv) + } + if v, found := p.p["forcks"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forcks", vv) + } if v, found := p.p["format"]; found { u.Set("format", v.(string)) } @@ -4811,6 +5250,48 @@ func (p *UpdateVnfTemplateParams) GetDisplaytext() (string, bool) { return value, ok } +func (p *UpdateVnfTemplateParams) SetForceupdateostype(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forceupdateostype"] = v +} + +func (p *UpdateVnfTemplateParams) ResetForceupdateostype() { + if p.p != nil && p.p["forceupdateostype"] != nil { + delete(p.p, "forceupdateostype") + } +} + +func (p *UpdateVnfTemplateParams) GetForceupdateostype() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forceupdateostype"].(bool) + return value, ok +} + +func (p *UpdateVnfTemplateParams) SetForcks(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forcks"] = v +} + +func (p *UpdateVnfTemplateParams) ResetForcks() { + if p.p != nil && p.p["forcks"] != nil { + delete(p.p, "forcks") + } +} + +func (p *UpdateVnfTemplateParams) GetForcks() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forcks"].(bool) + return value, ok +} + func (p *UpdateVnfTemplateParams) SetFormat(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5148,6 +5629,9 @@ type UpdateVnfTemplateResponse struct { Domainid string `json:"domainid"` Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Forcks bool `json:"forcks"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` Hostid string `json:"hostid"` diff --git a/cloudstack/VirtualNetworkFunctionsService_mock.go b/cloudstack/VirtualNetworkFunctionsService_mock.go index fe286d85..f9622d3e 100644 --- a/cloudstack/VirtualNetworkFunctionsService_mock.go +++ b/cloudstack/VirtualNetworkFunctionsService_mock.go @@ -259,17 +259,17 @@ func (mr *MockVirtualNetworkFunctionsServiceIfaceMockRecorder) NewDeleteVnfTempl } // NewDeployVnfApplianceParams mocks base method. -func (m *MockVirtualNetworkFunctionsServiceIface) NewDeployVnfApplianceParams(serviceofferingid, templateid, zoneid string) *DeployVnfApplianceParams { +func (m *MockVirtualNetworkFunctionsServiceIface) NewDeployVnfApplianceParams(serviceofferingid, zoneid string) *DeployVnfApplianceParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewDeployVnfApplianceParams", serviceofferingid, templateid, zoneid) + ret := m.ctrl.Call(m, "NewDeployVnfApplianceParams", serviceofferingid, zoneid) ret0, _ := ret[0].(*DeployVnfApplianceParams) return ret0 } // NewDeployVnfApplianceParams indicates an expected call of NewDeployVnfApplianceParams. -func (mr *MockVirtualNetworkFunctionsServiceIfaceMockRecorder) NewDeployVnfApplianceParams(serviceofferingid, templateid, zoneid any) *gomock.Call { +func (mr *MockVirtualNetworkFunctionsServiceIfaceMockRecorder) NewDeployVnfApplianceParams(serviceofferingid, zoneid any) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeployVnfApplianceParams", reflect.TypeOf((*MockVirtualNetworkFunctionsServiceIface)(nil).NewDeployVnfApplianceParams), serviceofferingid, templateid, zoneid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeployVnfApplianceParams", reflect.TypeOf((*MockVirtualNetworkFunctionsServiceIface)(nil).NewDeployVnfApplianceParams), serviceofferingid, zoneid) } // NewListVnfAppliancesParams mocks base method. diff --git a/cloudstack/ZoneService.go b/cloudstack/ZoneService.go index 7e428e5e..8ae1e103 100644 --- a/cloudstack/ZoneService.go +++ b/cloudstack/ZoneService.go @@ -333,6 +333,10 @@ func (p *CreateZoneParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("securitygroupenabled", vv) } + if v, found := p.p["storageaccessgroups"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("storageaccessgroups", vv) + } return u } @@ -651,6 +655,27 @@ func (p *CreateZoneParams) GetSecuritygroupenabled() (bool, bool) { return value, ok } +func (p *CreateZoneParams) SetStorageaccessgroups(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroups"] = v +} + +func (p *CreateZoneParams) ResetStorageaccessgroups() { + if p.p != nil && p.p["storageaccessgroups"] != nil { + delete(p.p, "storageaccessgroups") + } +} + +func (p *CreateZoneParams) GetStorageaccessgroups() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroups"].([]string) + return value, ok +} + // You should always use this function to get a new CreateZoneParams instance, // as then you are sure you have configured all required params func (s *ZoneService) NewCreateZoneParams(dns1 string, internaldns1 string, name string, networktype string) *CreateZoneParams { @@ -695,6 +720,8 @@ type CreateZoneResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainname string `json:"domainname"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Guestcidraddress string `json:"guestcidraddress"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` @@ -710,11 +737,13 @@ type CreateZoneResponse struct { Localstorageenabled bool `json:"localstorageenabled"` Name string `json:"name"` Networktype string `json:"networktype"` + Provider string `json:"provider"` Resourcedetails map[string]string `json:"resourcedetails"` Routedmodeenabled bool `json:"routedmodeenabled"` Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` + Storageaccessgroups string `json:"storageaccessgroups"` Tags []Tags `json:"tags"` Type string `json:"type"` Zonetoken string `json:"zonetoken"` @@ -2150,6 +2179,9 @@ func (p *ListZonesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("showicon", vv) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["tags"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -2391,6 +2423,27 @@ func (p *ListZonesParams) GetShowicon() (bool, bool) { return value, ok } +func (p *ListZonesParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListZonesParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListZonesParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListZonesParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2536,6 +2589,8 @@ type Zone struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainname string `json:"domainname"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Guestcidraddress string `json:"guestcidraddress"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` @@ -2551,11 +2606,13 @@ type Zone struct { Localstorageenabled bool `json:"localstorageenabled"` Name string `json:"name"` Networktype string `json:"networktype"` + Provider string `json:"provider"` Resourcedetails map[string]string `json:"resourcedetails"` Routedmodeenabled bool `json:"routedmodeenabled"` Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` + Storageaccessgroups string `json:"storageaccessgroups"` Tags []Tags `json:"tags"` Type string `json:"type"` Zonetoken string `json:"zonetoken"` @@ -2625,6 +2682,9 @@ func (p *ListZonesMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("showicon", vv) } + if v, found := p.p["storageaccessgroup"]; found { + u.Set("storageaccessgroup", v.(string)) + } if v, found := p.p["tags"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -2866,6 +2926,27 @@ func (p *ListZonesMetricsParams) GetShowicon() (bool, bool) { return value, ok } +func (p *ListZonesMetricsParams) SetStorageaccessgroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageaccessgroup"] = v +} + +func (p *ListZonesMetricsParams) ResetStorageaccessgroup() { + if p.p != nil && p.p["storageaccessgroup"] != nil { + delete(p.p, "storageaccessgroup") + } +} + +func (p *ListZonesMetricsParams) GetStorageaccessgroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageaccessgroup"].(string) + return value, ok +} + func (p *ListZonesMetricsParams) SetTags(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3020,6 +3101,8 @@ type ZonesMetric struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainname string `json:"domainname"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Guestcidraddress string `json:"guestcidraddress"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` @@ -3043,12 +3126,14 @@ type ZonesMetric struct { Memoryused string `json:"memoryused"` Name string `json:"name"` Networktype string `json:"networktype"` + Provider string `json:"provider"` Resourcedetails map[string]string `json:"resourcedetails"` Routedmodeenabled bool `json:"routedmodeenabled"` Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` State string `json:"state"` + Storageaccessgroups string `json:"storageaccessgroups"` Tags []Tags `json:"tags"` Type string `json:"type"` Zonetoken string `json:"zonetoken"` @@ -3716,6 +3801,8 @@ type UpdateZoneResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Domainname string `json:"domainname"` + Gputotal int64 `json:"gputotal"` + Gpuused int64 `json:"gpuused"` Guestcidraddress string `json:"guestcidraddress"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` @@ -3731,11 +3818,13 @@ type UpdateZoneResponse struct { Localstorageenabled bool `json:"localstorageenabled"` Name string `json:"name"` Networktype string `json:"networktype"` + Provider string `json:"provider"` Resourcedetails map[string]string `json:"resourcedetails"` Routedmodeenabled bool `json:"routedmodeenabled"` Routerprivateinterfacemaxmtu int `json:"routerprivateinterfacemaxmtu"` Routerpublicinterfacemaxmtu int `json:"routerpublicinterfacemaxmtu"` Securitygroupsenabled bool `json:"securitygroupsenabled"` + Storageaccessgroups string `json:"storageaccessgroups"` Tags []Tags `json:"tags"` Type string `json:"type"` Zonetoken string `json:"zonetoken"` diff --git a/generate/generate.go b/generate/generate.go index d65be258..0a5d5ec3 100644 --- a/generate/generate.go +++ b/generate/generate.go @@ -1424,6 +1424,14 @@ func (s *service) generateConvertCode(cmd, name, typ string) { case "otherdeployparams": pn(" u.Set(fmt.Sprintf(\"%s[%%d].name\", i), k)", name) pn(" u.Set(fmt.Sprintf(\"%s[%%d].value\", i), m[k])", name) + case "nodeofferings": + pn(" u.Set(fmt.Sprintf(\"%s[%%d].node\", i), k)", name) + pn(" u.Set(fmt.Sprintf(\"%s[%%d].offering\", i), m[k])", name) + case "nodetemplates": + pn(" u.Set(fmt.Sprintf(\"%s[%%d].node\", i), k)", name) + pn(" u.Set(fmt.Sprintf(\"%s[%%d].template\", i), m[k])", name) + case "cniconfigdetails": + pn(" u.Set(fmt.Sprintf(\"%s[%%d].%%s\", i, k), m[k])", name) default: if shouldUseStaticZeroIndex && !detailsRequireKeyValue[cmd] { pn(" u.Set(fmt.Sprintf(\"%s[0].%%s\", k), m[k])", name) diff --git a/generate/listApis.json b/generate/listApis.json index 790365cb..017bfead 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -6,26 +6,11 @@ "name": "createVPCOffering", "params": [ { - "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "set to true if the offering is to be enabled during creation. Default is false", - "length": 255, - "name": "enable", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "description": "desired service capabilities as part of vpc offering", "length": 255, - "name": "serviceproviderlist", + "name": "servicecapabilitylist", "required": false, + "since": "4.4", "type": "map" }, { @@ -36,6 +21,13 @@ "since": "4.20.0", "type": "string" }, + { + "description": "the display text of the vpc offering, defaults to the 'name'", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "true if the VPC offering supports choosing AS number", "length": 255, @@ -45,12 +37,11 @@ "type": "boolean" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", "length": 255, - "name": "networkmode", + "name": "serviceproviderlist", "required": false, - "since": "4.20.0", - "type": "string" + "type": "map" }, { "description": "the name of the vpc offering", @@ -60,11 +51,19 @@ "type": "string" }, { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", "length": 255, - "name": "fornsx", + "name": "internetprotocol", "required": false, - "since": "4.20.0", + "since": "4.17.0", + "type": "string" + }, + { + "description": "set to true if the offering is to be enabled during creation. Default is false", + "length": 255, + "name": "enable", + "required": false, + "since": "4.16", "type": "boolean" }, { @@ -76,10 +75,18 @@ "type": "uuid" }, { - "description": "the display text of the vpc offering, defaults to the 'name'", + "description": "services supported by the vpc offering", "length": 255, - "name": "displaytext", + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "length": 255, + "name": "networkmode", "required": false, + "since": "4.20.0", "type": "string" }, { @@ -92,19 +99,20 @@ "type": "list" }, { - "description": "true if network offering for NSX VPC offering supports Load balancer service.", + "description": "Name of the provider providing the service", "length": 255, - "name": "nsxsupportlb", + "name": "provider", "required": false, - "since": "4.20.0", - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "services supported by the vpc offering", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "supportedservices", + "name": "fornsx", "required": false, - "type": "list" + "since": "4.20.0", + "type": "boolean" }, { "description": "the ID of the containing domain(s), null for public offerings", @@ -115,98 +123,62 @@ "type": "list" }, { - "description": "desired service capabilities as part of vpc offering", + "description": "true if network offering for NSX VPC offering supports Load balancer service.", "length": 255, - "name": "servicecapabilitylist", + "name": "nsxsupportlb", "required": false, - "since": "4.4", - "type": "map" + "since": "4.20.0", + "type": "boolean" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" - }, - { - "description": "the name of the vpc offering", - "name": "name", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domain", "type": "string" }, - { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, {}, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", "type": "boolean" }, { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, { "description": "the list of supported services", "name": "service", @@ -216,23 +188,23 @@ "name": "provider", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the provider name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -240,36 +212,31 @@ "name": "canenableindividualservice", "type": "boolean" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "state of the network provider", "name": "state", "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" } ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { @@ -279,24 +246,65 @@ } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, { "description": "true if vpc offering can be used by NSX networks only", "name": "fornsx", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" } ] }, @@ -305,29 +313,6 @@ "isasync": false, "name": "ldapCreateAccount", "params": [ - { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - }, - { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, @@ -350,11 +335,11 @@ "type": "string" }, { - "description": "Network domain for the account's networks", + "description": "details for account used to store specific parameters", "length": 255, - "name": "networkdomain", + "name": "accountdetails", "required": false, - "type": "string" + "type": "map" }, { "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", @@ -363,6 +348,21 @@ "required": false, "type": "integer" }, + { + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "Creates the user under the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, @@ -376,13 +376,37 @@ "name": "accountid", "required": false, "type": "string" + }, + { + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" } ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ + {}, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { @@ -391,92 +415,212 @@ "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, { "description": "the ID of the role", "name": "roleid", "type": "string" }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, { "description": "details for the account", "name": "accountdetails", "type": "map" }, + { + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, { "description": "the total number of networks the account can own", "name": "networklimit", "type": "string" }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "account type (admin, domain-admin, user)", "name": "accounttype", "type": "integer" }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the user state", - "name": "state", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -484,24 +628,29 @@ "name": "firstname", "type": "string" }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, { "description": "the timezone user was created in", "name": "timezone", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -515,58 +664,58 @@ "type": "resourceiconresponse" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, { "description": "true if user has two factor authentication enabled", "name": "is2faenabled", "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -578,68 +727,43 @@ "type": "list" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { @@ -648,180 +772,139 @@ "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, - {}, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - {}, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, + {}, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" } ], @@ -832,14 +915,6 @@ "isasync": true, "name": "copyIso", "params": [ - { - "description": "Template ID.", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, { "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", "length": 255, @@ -849,57 +924,71 @@ "type": "list" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "sourcezoneid", + "name": "destzoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "ID of the zone the template is being copied to.", + "description": "Template ID.", "length": 255, - "name": "destzoneid", + "name": "id", + "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "length": 255, + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, + {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { @@ -908,58 +997,128 @@ "type": "long" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, - {}, { "description": "the ID of the OS type for this template.", "name": "ostypeid", "type": "string" }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "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", + "name": "userdataparams", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -968,28 +1127,28 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -1001,23 +1160,18 @@ "type": "set" }, { - "description": "the template ID", - "name": "id", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the template name", - "name": "name", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { @@ -1026,59 +1180,60 @@ "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, + {}, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "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", - "name": "userdataparams", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { "description": "the userdata override policy with the userdata provided while deploying VM", @@ -1086,125 +1241,69 @@ "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { "description": "true if template requires HVM enabled, false otherwise", "name": "requireshvm", "type": "boolean" }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - {}, { "description": "the type of the template", "name": "templatetype", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" } ] }, @@ -1223,27 +1322,27 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -1260,19 +1359,19 @@ "type": "integer" }, { - "description": "", + "description": "ID of the storage policy", "length": 255, - "name": "page", + "name": "policyid", + "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "ID of the zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -1282,10 +1381,10 @@ "type": "string" }, { - "description": "ID of the storage policy", + "description": "ID of the zone", "length": 255, - "name": "policyid", - "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" } @@ -1293,68 +1392,79 @@ "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the storage pool type", - "name": "type", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", + "description": "the storage pool details", + "name": "details", "type": "map" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { @@ -1363,14 +1473,14 @@ "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { "description": "true if the entity/resource has annotations", @@ -1378,85 +1488,84 @@ "type": "boolean" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", + "description": "the storage pool capabilities", + "name": "storagecapabilities", "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, + {}, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, - {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" } ] @@ -1486,23 +1595,13 @@ "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { @@ -1511,18 +1610,13 @@ "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { @@ -1531,8 +1625,8 @@ "type": "integer" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -1541,29 +1635,14 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" - }, - { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "the Zone name for the system VM", @@ -1571,8 +1650,8 @@ "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -1581,23 +1660,23 @@ "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { @@ -1606,33 +1685,34 @@ "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { @@ -1641,8 +1721,13 @@ "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" + }, + { + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -1651,22 +1736,25 @@ "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, - {}, - {}, { "description": "the date and time the system VM was created", "name": "created", @@ -1678,28 +1766,39 @@ "type": "list" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + { + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" } ] @@ -1710,90 +1809,79 @@ "name": "listDedicatedZones", "params": [ { - "description": "the ID of the domain associated with the zone", + "description": "the ID of the Zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "list dedicated zones by affinity group", "length": 255, - "name": "pagesize", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the Zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list dedicated zones by affinity group", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "the name of the account associated with the zone. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the name of the account associated with the zone. Must be used with domainId.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "dedicateZone", "response": [ - { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" }, + {}, { "description": "the Account Id to which the Zone is dedicated", "name": "accountid", "type": "string" }, - {}, - { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" - }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { @@ -1801,10 +1889,21 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", + "type": "string" + }, { "description": "the Dedication Affinity Group ID of the zone", "name": "affinitygroupid", "type": "string" + }, + {}, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" } ] }, @@ -1824,51 +1923,51 @@ "related": "", "response": [ { - "description": "the current available space of the pool", - "name": "size", + "description": "available iops of the pool", + "name": "maxiops", "type": "long" }, { - "description": "controller of the pool", - "name": "controllerid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "available iops of the pool", - "name": "maxiops", + "description": "the current available space of the pool", + "name": "size", "type": "long" }, { - "description": "default gateway of the pool", - "name": "gateway", + "description": "controller of the pool", + "name": "controllerid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the state of the storage pool", + "name": "state", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "default gateway of the pool", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -1896,25 +1995,11 @@ ], "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" - }, - { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "AS number of bgp peer", @@ -1922,31 +2007,30 @@ "type": "long" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the account of the bgp peer", - "name": "account", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, - {}, { "description": "the domain name of the bgp peer", "name": "domain", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, { "description": "password of bgp peer", "name": "password", @@ -1954,9 +2038,9 @@ }, {}, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { "description": "the project name of the bgp peer", @@ -1964,19 +2048,34 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" } ], "since": "4.20.0" @@ -1987,12 +2086,11 @@ "name": "listTungstenFabricLBHealthMonitor", "params": [ { - "description": "the ID of lb rule", + "description": "", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -2004,55 +2102,60 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "the ID of lb rule", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "related": "updateTungstenFabricLBHealthMonitor", "response": [ { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" }, - {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, - { - "description": "the health monitor retry", - "name": "retry", - "type": "int" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { "description": "the health monitor UUID", "name": "uuid", "type": "string" }, - {}, { - "description": "the health monitor interval", - "name": "interval", + "description": "the health monitor ID", + "name": "id", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the health monitor retry", + "name": "retry", "type": "int" }, { @@ -2060,430 +2163,695 @@ "name": "expectedcode", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "the health monitor type", "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the health monitor interval", + "name": "interval", + "type": "int" }, + {}, { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" } ] }, { - "description": "Deletes account from the project", + "description": "Removes external nodes from a CKS cluster. ", "isasync": true, - "name": "deleteAccountFromProject", + "name": "removeNodesFromKubernetesCluster", "params": [ { - "description": "ID of the project to remove the account from", + "description": "comma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS)", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "nodeids", + "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", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "name of the account to be removed from the project", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "account", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster,removeNodesFromKubernetesCluster", "required": true, - "type": "string" + "type": "uuid" } ], + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Updates the information about Guest OS", - "isasync": true, - "name": "updateGuestOs", - "params": [ { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "UUID of the Guest OS", - "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs,updateGuestOs", - "required": true, - "type": "uuid" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "whether this guest OS is available for end users", - "length": 255, - "name": "forDisplay", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "related": "listOsTypes,addGuestOs", - "response": [ + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the OS type", + "description": "the id of the Kubernetes cluster", "name": "id", "type": "string" }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, - {}, - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - }, { - "description": "the name of the OS type", - "name": "name", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, - {} - ], - "since": "4.4.0" - }, - { - "description": "Lists all guest vlans", - "isasync": false, - "name": "listGuestVlans", - "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "list guest vlan by physical network", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, { - "description": "limits search results to allocated guest vlan. false by default.", - "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "list guest vlan by vnet", - "length": 255, - "name": "vnet", - "required": false, + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "list guest vlan by zone", - "length": 255, + "description": "the name of the zone of the Kubernetes cluster", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list guest vlan by id", - "length": 255, - "name": "id", - "required": false, - "type": "long" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, - {}, { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", - "type": "boolean" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the guest VLAN", - "name": "vlan", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the guest VLAN range", + "description": "the name of the domain in which the Kubernetes cluster exists", "name": "domain", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, - {}, { - "description": "the guest VLAN id", - "name": "id", - "type": "long" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { - "description": "the project id of the guest VLAN range", - "name": "projectid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" }, { - "description": "date the guest VLAN was taken", - "name": "taken", - "type": "date" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", + "type": "string" }, { - "description": "the zone ID of the guest VLAN range", - "name": "zoneid", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" - } - ], - "since": "4.17.0" + }, + { + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" + }, + {}, + { + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + } + ], + "since": "4.21.0" }, { - "description": "Updates resource limits for an account or domain.", - "isasync": false, - "name": "updateResourceLimit", + "description": "Deletes account from the project", + "isasync": true, + "name": "deleteAccountFromProject", "params": [ { - "description": "Tag for the resource type", + "description": "name of the account to be removed from the project", "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", + "name": "account", + "required": true, "type": "string" }, { - "description": "Update resource limits for project", + "description": "ID of the project to remove the account from", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Updates the information about Guest OS", + "isasync": true, + "name": "updateGuestOs", + "params": [ + { + "description": "the ID of the OS category", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory,updateOsCategory", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": " Maximum resource limit.", + "description": "whether this guest OS is available for end users", "length": 255, - "name": "max", + "name": "forDisplay", + "required": false, + "type": "boolean" + }, + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "UUID of the Guest OS", + "length": 255, + "name": "id", + "related": "listOsTypes,addGuestOs,updateGuestOs", + "required": true, + "type": "uuid" + }, + { + "description": "Unique display name for Guest OS", + "length": 255, + "name": "osdisplayname", + "required": false, + "type": "string" + } + ], + "related": "listOsTypes,addGuestOs", + "response": [ + { + "description": "the ID of the OS category", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ID of the OS type", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the name of the OS category", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, + {}, + { + "description": "the name of the OS type", + "name": "name", + "type": "string" + }, + { + "description": "the name/description of the OS type", + "name": "description", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "Lists all guest vlans", + "isasync": false, + "name": "listGuestVlans", + "params": [ + { + "description": "list guest vlan by vnet", + "length": 255, + "name": "vnet", + "required": false, + "type": "string" + }, + { + "description": "list guest vlan by id", + "length": 255, + "name": "id", "required": false, "type": "long" }, { - "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", + "description": "list guest vlan by zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "", "length": 255, - "name": "resourcetype", - "required": true, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "description": "limits search results to allocated guest vlan. false by default.", "length": 255, - "name": "account", + "name": "allocatedonly", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list guest vlan by physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" } ], - "related": "listResourceLimits", + "related": "", "response": [ { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, + { + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" + }, + { + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" + }, + { + "description": "the guest VLAN id", + "name": "id", + "type": "long" + }, + { + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" + }, {}, { - "description": "The tag for the resource limit", - "name": "tag", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, + {}, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "path of the domain to which the resource limit belongs", + "description": "path of the domain to which the guest VLAN range belongs", "name": "domainpath", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "description": "the zone name of the guest VLAN range", + "name": "zonename", + "type": "string" + }, + { + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + }, + { + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the guest VLAN range", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "Updates resource limits for an account or domain.", + "isasync": false, + "name": "updateResourceLimit", + "params": [ + { + "description": " Maximum resource limit.", + "length": 255, "name": "max", + "required": false, "type": "long" }, + { + "description": "Update resource limits for project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "integer" + } + ], + "related": "listResourceLimits", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" + }, + { + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", + "type": "string" + }, + {}, + { + "description": "the domain name of the resource limit", + "name": "domain", + "type": "string" + }, + {}, { "description": "the account of the resource limit", "name": "account", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, { @@ -2496,7 +2864,16 @@ "name": "projectid", "type": "string" }, - {}, + { + "description": "the domain ID of the resource limit", + "name": "domainid", + "type": "string" + }, + { + "description": "The tag for the resource limit", + "name": "tag", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -2505,42 +2882,133 @@ ] }, { - "description": "Deletes a static route", - "isasync": true, - "name": "deleteStaticRoute", + "description": "Removes an existing GUI theme.", + "isasync": false, + "name": "removeGuiTheme", "params": [ { - "description": "the ID of the static route", + "description": "The unique identifier of the GUI theme to be removed.", "length": 255, "name": "id", - "related": "createStaticRoute,listStaticRoutes", + "related": "listGuiThemes,updateGuiTheme,createGuiTheme,removeGuiTheme", "required": true, "type": "uuid" } ], + "related": "listGuiThemes,updateGuiTheme,createGuiTheme", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", + "type": "string" + }, + { + "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`.", + "name": "ispublic", "type": "boolean" }, + { + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", + "type": "string" + }, + {}, + { + "description": "Name of the GUI theme.", + "name": "name", + "type": "string" + }, + { + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", + "type": "string" + }, + { + "description": "ID of the custom GUI theme.", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" + }, + { + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" + }, + { + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "Description of the GUI theme.", + "name": "description", + "type": "string" + }, + { + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", + "type": "string" + } + ], + "since": "4.21.0.0" + }, + { + "description": "Deletes a static route", + "isasync": true, + "name": "deleteStaticRoute", + "params": [ + { + "description": "the ID of the static route", + "length": 255, + "name": "id", + "related": "createStaticRoute,listStaticRoutes", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -2559,9 +3027,16 @@ ], "related": "", "response": [ + {}, + {}, { - "description": "crt", - "name": "crt", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "chain", + "name": "chain", "type": "string" }, { @@ -2570,21 +3045,14 @@ "type": "string" }, { - "description": "chain", - "name": "chain", + "description": "crt", + "name": "crt", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -2604,26 +3072,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -2633,33 +3101,24 @@ "name": "startRollingMaintenance", "params": [ { - "description": "the IDs of the clusters to start maintenance on", - "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "list" - }, - { - "description": "the IDs of the zones to start maintenance on", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "payload", "required": false, - "type": "list" + "type": "string" }, { - "description": "the command to execute while hosts are on maintenance", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "payload", + "name": "forced", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the IDs of the hosts to start maintenance on", + "description": "the IDs of the pods to start maintenance on", "length": 255, - "name": "hostids", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "podids", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "list" }, @@ -2671,19 +3130,28 @@ "type": "integer" }, { - "description": "the IDs of the pods to start maintenance on", + "description": "the IDs of the zones to start maintenance on", "length": 255, - "name": "podids", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "list" }, { - "description": "if rolling mechanism should continue in case of an error", + "description": "the IDs of the hosts to start maintenance on", "length": 255, - "name": "forced", + "name": "hostids", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, - "type": "boolean" + "type": "list" + }, + { + "description": "the IDs of the clusters to start maintenance on", + "length": 255, + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "list" } ], "related": "", @@ -2693,29 +3161,28 @@ "name": "details", "type": "string" }, - {}, { "description": "the hosts updated", "name": "hostsupdated", "response": [ { - "description": "the ID of the updated host", - "name": "hostid", + "description": "the name of the updated host", + "name": "hostname", "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", + "description": "end date of the update on the host", + "name": "enddate", "type": "string" }, { - "description": "the name of the updated host", - "name": "hostname", + "description": "the ID of the updated host", + "name": "hostid", "type": "string" }, { - "description": "end date of the update on the host", - "name": "enddate", + "description": "start date of the update on the host", + "name": "startdate", "type": "string" }, { @@ -2727,11 +3194,6 @@ "type": "list" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the hosts skipped", "name": "hostsskipped", @@ -2742,27 +3204,33 @@ "type": "string" }, { - "description": "the ID of the skipped host", - "name": "hostid", + "description": "the name of the skipped host", + "name": "hostname", "type": "string" }, { - "description": "the name of the skipped host", - "name": "hostname", + "description": "the ID of the skipped host", + "name": "hostid", "type": "string" } ], "type": "list" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "indicates if the rolling maintenance operation was successful", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -2772,11 +3240,11 @@ "name": "listTungstenFabricApplicationPolicySet", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of zone", @@ -2794,11 +3262,11 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -2811,19 +3279,19 @@ "related": "createTungstenFabricApplicationPolicySet", "response": [ { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", - "type": "string" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -2831,27 +3299,27 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, {}, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" - } + }, + {} ] }, { @@ -2867,35 +3335,35 @@ "type": "string" }, { - "description": "the ID of the network ACL", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Name of the network ACL list", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", "type": "string" }, { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "Name of the network ACL list", + "description": "the ID of the network ACL", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" } ], "response": [ @@ -2904,23 +3372,23 @@ "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], "since": "4.4" }, @@ -2930,37 +3398,28 @@ "name": "restoreVirtualMachine", "params": [ { - "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", + "description": "used to specify the custom parameters", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "details", "required": false, - "type": "uuid" - }, - { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "since": "4.19.1", + "type": "map" }, { - "description": "Override root volume's diskoffering.", + "description": "Optional field to expunge old root volume after restore.", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "expunge", "required": false, "since": "4.19.1", - "type": "uuid" + "type": "boolean" }, { - "description": "used to specify the custom parameters", + "description": "Virtual Machine ID", "length": 255, - "name": "details", - "required": false, - "since": "4.19.1", - "type": "map" + "name": "virtualmachineid", + "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", + "required": true, + "type": "uuid" }, { "description": "Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", @@ -2971,40 +3430,206 @@ "type": "long" }, { - "description": "Optional field to expunge old root volume after restore.", + "description": "Override root volume's diskoffering.", "length": 255, - "name": "expunge", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, "since": "4.19.1", - "type": "boolean" + "type": "uuid" + }, + { + "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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": [ { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": "List of read-only Vm details as comma separated string.", @@ -3012,176 +3637,245 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, - {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, { "description": "the name of the backup offering of the virtual machine", "name": "backupofferingname", "type": "string" }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, - {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "VNF details", @@ -3189,107 +3883,102 @@ "type": "map" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, - {}, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { "description": "the memory allocated for the virtual machine", @@ -3297,468 +3986,219 @@ "type": "integer" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, { "description": "the ID of the backup offering of the virtual machine", "name": "backupofferingid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - } - ], - "type": "set" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", "type": "set" }, { @@ -3767,47 +4207,52 @@ "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -3815,8 +4260,8 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -3825,8 +4270,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -3835,8 +4280,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -3849,89 +4299,64 @@ "name": "project", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -3939,18 +4364,18 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -3959,42 +4384,77 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" @@ -4010,73 +4470,141 @@ "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], "type": "set" }, { "description": "the name of the security group", "name": "name", "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" } ], "type": "set" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" - } + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + {} ], "since": "3.0.0" }, @@ -4095,27 +4623,27 @@ } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -4133,17 +4661,7 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -4154,7 +4672,17 @@ "name": "displaytext", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -4171,11 +4699,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -4185,26 +4713,15 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "associateUcsProfileToBlade", "response": [ - {}, - { - "description": "associated ucs profile dn", - "name": "profiledn", - "type": "string" - }, - { - "description": "ucs blade id", - "name": "id", - "type": "string" - }, { "description": "ucs blade dn", "name": "bladedn", @@ -4215,22 +4732,33 @@ "name": "jobstatus", "type": "integer" }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ucs blade id", + "name": "id", + "type": "string" + }, { "description": "ucs manager id", "name": "ucsmanagerid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { "description": "cloudstack host id this blade associates to", "name": "hostid", "type": "string" - }, - {} + } ] }, { @@ -4248,35 +4776,119 @@ ], "related": "getVolumeiScsiName", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Updates an OS category", + "isasync": false, + "name": "updateOsCategory", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "ID of the OS category", + "length": 255, + "name": "id", + "related": "listOsCategories,addOsCategory,updateOsCategory", + "required": true, + "type": "uuid" + }, + { + "description": "sort key of the OS category for listing", + "length": 255, + "name": "sortkey", + "required": false, "type": "integer" }, - {}, + { + "description": "Whether the category is featured or not", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "Name for the OS category", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "listOsCategories,addOsCategory", + "response": [ + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Whether the OS category is featured", + "name": "isfeatured", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the ID of the OS category", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" + }, + { + "description": "the name of the OS category", + "name": "name", + "type": "string" + }, {} - ] + ], + "since": "4.21.0" }, { "description": "Updates a host.", "isasync": false, "name": "updateHost", "params": [ + { + "description": "the new uri for the secondary storage: nfs://host/path", + "length": 255, + "name": "url", + "required": false, + "type": "string" + }, { "description": "the id of Os category to update the host with", "length": 255, "name": "oscategoryid", - "related": "listOsCategories", + "related": "listOsCategories,addOsCategory", "required": false, "type": "uuid" }, @@ -4288,12 +4900,12 @@ "type": "list" }, { - "description": "the ID of the host to update", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": true, - "type": "uuid" + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { "description": "Change the name of host", @@ -4304,9 +4916,9 @@ "type": "string" }, { - "description": "the new uri for the secondary storage: nfs://host/path", + "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", "length": 255, - "name": "url", + "name": "allocationstate", "required": false, "type": "string" }, @@ -4318,82 +4930,95 @@ "type": "boolean" }, { - "description": "Add an annotation to this host", + "description": "the ID of the host to update", "length": 255, - "name": "annotation", - "required": false, - "since": "4.11", - "type": "string" + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "required": true, + "type": "uuid" }, { - "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", + "description": "Add an annotation to this host", "length": 255, - "name": "allocationstate", + "name": "annotation", "required": false, + "since": "4.11", "type": "string" } ], "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "response": [ { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" }, { "description": "the date and time the host was removed", @@ -4401,24 +5026,39 @@ "type": "date" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { "description": "the CPU speed of the host", @@ -4426,9 +5066,14 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { "description": "GPU cards present in the host", @@ -4439,8 +5084,8 @@ "name": "vgpu", "response": [ { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { @@ -4448,11 +5093,6 @@ "name": "maxheads", "type": "long" }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, { "description": "Model Name of vGPU", "name": "vgputype", @@ -4464,18 +5104,23 @@ "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" } ], @@ -4490,242 +5135,261 @@ "type": "list" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, - {}, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "events available for the host", - "name": "events", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, - {}, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" - } + }, + {} ] }, { @@ -4733,13 +5397,6 @@ "isasync": true, "name": "createEgressFirewallRule", "params": [ - { - "description": "the starting port of firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, { "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, @@ -4754,6 +5411,20 @@ "required": false, "type": "list" }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, { "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, @@ -4763,20 +5434,12 @@ "type": "boolean" }, { - "description": "error code for this icmp message", + "description": "type of the icmp message being sent", "length": 255, - "name": "icmpcode", + "name": "icmptype", "required": false, "type": "integer" }, - { - "description": "the network id of the port forwarding rule", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, { "description": "type of firewallrule: system/user", "length": 255, @@ -4785,9 +5448,9 @@ "type": "string" }, { - "description": "the ending port of firewall rule", + "description": "the starting port of firewall rule", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" }, @@ -4799,63 +5462,68 @@ "type": "list" }, { - "description": "type of the icmp message being sent", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" } ], "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, - {}, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -4864,23 +5532,23 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -4889,31 +5557,21 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { @@ -4922,20 +5580,24 @@ "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, - {}, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { "description": "the ending port of firewall rule's port range", @@ -4943,15 +5605,17 @@ "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" - } + }, + {} ] }, { @@ -4960,64 +5624,70 @@ "name": "listSecurityGroups", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists security groups by virtual machine id", + "description": "List by keyword", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list the security group by the id provided", + "description": "lists security groups by name", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists security groups by name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "securitygroupname", + "name": "account", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "list the security group by the id provided", + "length": 255, + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "required": false, + "type": "uuid" }, { "description": "", @@ -5034,175 +5704,115 @@ "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "account", + "name": "virtualmachineid", + "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", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ - {}, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "set" }, - {}, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -5210,23 +5820,43 @@ "name": "startport", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -5235,179 +5865,253 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + {}, { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "tag value", - "name": "value", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the security group", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Enables a role", + "isasync": false, + "name": "enableRole", + "params": [ + { + "description": "ID of the role", + "length": 255, + "name": "id", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.20.0" }, { "description": "List OAuth providers registered", @@ -5415,33 +6119,33 @@ "name": "listOauthProvider", "params": [ { - "description": "the ID of the OAuth provider", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Name of the provider", "length": 255, - "name": "pagesize", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Name of the provider", + "description": "", "length": 255, - "name": "provider", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the OAuth provider", "length": 255, - "name": "keyword", + "name": "id", + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -5453,100 +6157,60 @@ ], "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", "response": [ + {}, { "description": "ID of the provider", "name": "id", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Name of the provider", - "name": "provider", - "type": "string" - }, { "description": "Name of the provider", "name": "name", "type": "string" }, - {}, { - "description": "Description of the provider registered", - "name": "description", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Name of the provider", + "name": "provider", "type": "string" }, - {}, - { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" - }, { "description": "Client ID registered in the OAuth provider", "name": "clientid", "type": "string" }, - { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Enables a role", - "isasync": false, - "name": "enableRole", - "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "id", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "Description of the provider registered", + "name": "description", + "type": "string" } ], - "since": "4.20.0" + "since": "4.19.0" }, { "description": "Delete Service Package", @@ -5563,13 +6227,13 @@ } ], "response": [ + {}, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -5592,14 +6256,6 @@ "isasync": false, "name": "updateSharedFileSystem", "params": [ - { - "description": "the ID of the shared filesystem", - "length": 255, - "name": "id", - "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": true, - "type": "uuid" - }, { "description": "the name of the shared filesystem.", "length": 255, @@ -5613,133 +6269,274 @@ "name": "description", "required": false, "type": "string" + }, + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" } ], "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + {}, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the domain associated with the shared filesystem", "name": "domain", "type": "string" }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, { "description": "name of the storage fs data volume", "name": "volumename", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "true if nic is default, false otherwise", @@ -5747,201 +6544,117 @@ "type": "boolean" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { "description": "public IP address id associated with this nic via Static nat rule", "name": "publicipid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - {}, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" } ], - "type": "set" - }, - { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - {}, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" + "type": "list" }, { "description": "the shared filesystem's disk read in KiB", @@ -5949,105 +6662,56 @@ "type": "long" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, + {}, { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "disk offering display text for the shared filesystem", "name": "diskofferingdisplaytext", @@ -6079,45 +6743,30 @@ ], "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "response": [ - {}, - { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" - }, - { - "description": "the project id of the IPv4 subnet", - "name": "projectid", - "type": "string" - }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, { "description": "the project name of the IPv4 subnet", "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, + {}, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -6130,16 +6779,31 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, { "description": "the domain name of the IPv4 subnet", "name": "domain", "type": "string" + }, + {}, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" } ], "since": "4.20.0" @@ -6161,29 +6825,34 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "the Zone name for the system VM", @@ -6191,23 +6860,28 @@ "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { @@ -6216,25 +6890,30 @@ "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the public MAC address for the system VM", @@ -6242,53 +6921,33 @@ "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -6297,23 +6956,18 @@ "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" - }, - { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { @@ -6322,59 +6976,59 @@ "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the name of the system VM", + "name": "name", "type": "string" }, - {}, { "description": "the state of the system VM", "name": "state", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" } ] @@ -6384,6 +7038,14 @@ "isasync": false, "name": "archiveEvents", "params": [ + { + "description": "the IDs of the events", + "length": 255, + "name": "ids", + "related": "listEvents", + "required": false, + "type": "list" + }, { "description": "archive by event type", "length": 255, @@ -6398,14 +7060,6 @@ "required": false, "type": "date" }, - { - "description": "the IDs of the events", - "length": 255, - "name": "ids", - "related": "listEvents", - "required": false, - "type": "list" - }, { "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, @@ -6415,12 +7069,6 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -6431,6 +7079,12 @@ "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -6445,18 +7099,18 @@ "name": "listASNumbers", "params": [ { - "description": "domain id", + "description": "the zone ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the vpc id", + "description": "domain id", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, @@ -6476,18 +7130,12 @@ "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "the network id", "length": 255, - "name": "page", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the AS Number range ID", @@ -6497,14 +7145,6 @@ "required": false, "type": "uuid" }, - { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "account name", "length": 255, @@ -6514,13 +7154,27 @@ "type": "string" }, { - "description": "the network id", + "description": "the vpc id", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "to indicate if the AS number is allocated to any network", "length": 255, @@ -6532,18 +7186,14 @@ "related": "", "response": [ { - "description": "AS Number ID", - "name": "asnrangeid", - "type": "string" - }, - { - "description": "VPC ID", - "name": "vpcid", + "description": "Allocation state", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "the account name", - "name": "account", + "description": "the zone name of the AS Number range", + "name": "zonename", "type": "string" }, { @@ -6551,51 +7201,39 @@ "name": "created", "type": "date" }, - { - "description": "AS Number", - "name": "asnumber", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Domain ID", - "name": "domainid", + "description": "the account name", + "name": "account", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "the domain name", + "name": "domain", "type": "string" }, { - "description": "Zone ID", - "name": "zoneid", + "description": "VPC Name", + "name": "vpcname", "type": "string" }, - {}, - {}, - { - "description": "Allocated Date", - "name": "allocated", - "type": "date" - }, { - "description": "Network ID", - "name": "associatednetworkid", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "ID of the AS Number", - "name": "id", + "description": "AS Number ID", + "name": "asnrangeid", "type": "string" }, { - "description": "Account ID", - "name": "accountid", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { @@ -6604,28 +7242,44 @@ "type": "string" }, { - "description": "the zone name of the AS Number range", - "name": "zonename", - "type": "string" + "description": "AS Number", + "name": "asnumber", + "type": "long" }, + {}, { "description": "Network Name", "name": "associatednetworkname", "type": "string" }, { - "description": "the domain name", - "name": "domain", + "description": "Network ID", + "name": "associatednetworkid", "type": "string" }, { - "description": "VPC Name", - "name": "vpcname", + "description": "ID of the AS Number", + "name": "id", "type": "string" }, { - "description": "Allocation state", - "name": "allocationstate", + "description": "Domain ID", + "name": "domainid", + "type": "string" + }, + { + "description": "Allocated Date", + "name": "allocated", + "type": "date" + }, + { + "description": "Account ID", + "name": "accountid", + "type": "string" + }, + { + "description": "VPC ID", + "name": "vpcid", "type": "string" } ], @@ -6646,27 +7300,27 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.2.0" @@ -6677,25 +7331,27 @@ "name": "listUserData", "params": [ { - "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.", + "description": "Userdata name to look for", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the ID of the Userdata", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listUserData,listCniConfiguration", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -6705,26 +7361,25 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -6735,94 +7390,93 @@ "type": "uuid" }, { - "description": "Userdata name to look for", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the Userdata", + "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.", "length": 255, - "name": "id", - "related": "listUserData", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" } ], - "related": "", + "related": "listCniConfiguration", "response": [ { - "description": "the domain name of the userdata owner", - "name": "domain", + "description": "the project name of the User Data", + "name": "project", "type": "string" }, { - "description": "base64 encoded userdata content", - "name": "userdata", + "description": "path of the domain to which the User Data owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "the owner id of the userdata", - "name": "accountid", + "description": "the domain name of the User Data owner", + "name": "domain", "type": "string" }, {}, - { - "description": "path of the domain to which the userdata owner belongs", - "name": "domainpath", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the owner id of the User Data", + "name": "accountid", "type": "string" }, { - "description": "the owner of the userdata", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the userdata", - "name": "project", + "description": "the domain id of the User Data owner", + "name": "domainid", "type": "string" }, { - "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", + "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", "name": "params", "type": "string" }, + { + "description": "ID of the User Data", + "name": "id", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the domain id of the userdata owner", - "name": "domainid", + "description": "Name of the User Data", + "name": "name", "type": "string" }, { - "description": "Name of the userdata", - "name": "name", + "description": "the owner of the User Data", + "name": "account", "type": "string" }, { - "description": "the project id of the userdata", + "description": "the project id of the User Data", "name": "projectid", "type": "string" + }, + { + "description": "base64 encoded User Data content", + "name": "userdata", + "type": "string" } ], "since": "4.18" @@ -6832,6 +7486,14 @@ "isasync": true, "name": "updateLoadBalancer", "params": [ + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -6844,56 +7506,37 @@ "description": "the ID of the load balancer", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": true, "type": "uuid" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" } ], "related": "createLoadBalancer,listLoadBalancers", "response": [ { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" - }, - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" }, + {}, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, { @@ -6901,14 +7544,15 @@ "name": "domain", "type": "string" }, + {}, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { @@ -6921,8 +7565,8 @@ "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the instance ID", + "name": "id", "type": "string" }, { @@ -6931,37 +7575,63 @@ "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" } ], "type": "list" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -6969,33 +7639,33 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -7004,52 +7674,36 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, - {}, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", + "description": "the Load Balancer ID", + "name": "id", "type": "string" } ], @@ -7087,28 +7741,28 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { @@ -7117,18 +7771,13 @@ "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" - }, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { @@ -7137,85 +7786,80 @@ "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, {}, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, - {}, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { @@ -7224,9 +7868,9 @@ "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { "description": "the Pod name for the system VM", @@ -7234,74 +7878,74 @@ "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" } ] }, @@ -7310,13 +7954,6 @@ "isasync": false, "name": "verifyOAuthCodeAndGetUser", "params": [ - { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", - "length": 255, - "name": "secretcode", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -7338,6 +7975,13 @@ "required": false, "type": "integer" }, + { + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -7349,15 +7993,14 @@ "related": "updateOauthProvider", "response": [ { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, - {}, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "ID of the provider", @@ -7365,40 +8008,41 @@ "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" + "description": "Name of the provider", + "name": "provider", + "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { "description": "Name of the provider", - "name": "provider", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Client ID registered in the OAuth provider", + "name": "clientid", + "type": "string" }, + {}, + {}, { - "description": "Name of the provider", - "name": "name", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", - "type": "string" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" } ], "since": "4.19.0" @@ -7408,13 +8052,6 @@ "isasync": false, "name": "listClusterDrsPlan", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "ID of the cluster", "length": 255, @@ -7423,6 +8060,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -7431,11 +8075,11 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "ID of the drs plan", @@ -7448,11 +8092,6 @@ ], "related": "generateClusterDrsPlan,executeClusterDrsPlan", "response": [ - { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - }, { "description": "Start event Id of the DRS Plan", "name": "eventid", @@ -7460,36 +8099,41 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, - {}, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" + }, + { + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -7500,61 +8144,62 @@ "name": "listClusters", "params": [ { - "description": "List by keyword", + "description": "lists clusters by Zone ID", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by the cluster name", + "description": "CPU arch of the clusters", "length": 255, - "name": "name", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "lists clusters by allocation state", "length": 255, - "name": "managedstate", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "lists clusters by Zone ID", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, { - "description": "lists clusters by allocation state", + "description": "", "length": 255, - "name": "allocationstate", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by the cluster name", "length": 255, - "name": "showcapacities", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "CPU arch of the clusters", + "description": "List by keyword", "length": 255, - "name": "arch", + "name": "keyword", "required": false, - "since": "4.20.1", "type": "string" }, { @@ -7565,72 +8210,94 @@ "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by cluster type", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "clustertype", + "required": false, + "type": "string" + }, + { + "description": "lists clusters by Pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "lists clusters by cluster type", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "clustertype", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the name of the storage access group", "length": 255, - "name": "pagesize", + "name": "storageaccessgroup", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "managedstate", "required": false, - "type": "uuid" + "type": "string" } ], "related": "addCluster,updateCluster", "response": [ { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, + {}, { "description": "the Pod name of the cluster", "name": "podname", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { @@ -7639,24 +8306,38 @@ "type": "map" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { "description": "The cpu overcommit ratio of the cluster", "name": "cpuovercommitratio", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { @@ -7669,19 +8350,24 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the Pod name", @@ -7689,13 +8375,18 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -7709,56 +8400,43 @@ "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" } ], "type": "list" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, + {}, + {}, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" } ] @@ -7769,26 +8447,27 @@ "name": "listProjectInvitations", "params": [ { - "description": "list invitation by user ID", + "description": "list invitations by id", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "id", + "related": "listProjectInvitations", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "list by project id", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -7798,41 +8477,39 @@ "type": "boolean" }, { - "description": "list by project id", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "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.", + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "listall", + "name": "activeonly", "required": false, "type": "boolean" }, { - "description": "list invitations by id", + "description": "list invitations by state", "length": 255, - "name": "id", - "related": "listProjectInvitations", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -7843,18 +8520,19 @@ "type": "uuid" }, { - "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", + "description": "list invitation by user ID", "length": 255, - "name": "activeonly", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list invitations by state", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", @@ -7865,8 +8543,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { @@ -7874,10 +8552,14 @@ "name": "id", "type": "string" }, - {}, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the project", + "name": "project", "type": "string" }, {}, @@ -7891,24 +8573,20 @@ "name": "account", "type": "string" }, + {}, { - "description": "path of the Domain the project belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the project", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { @@ -7917,9 +8595,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the Domain the project belongs to", + "name": "domainpath", + "type": "string" } ], "since": "3.0.0" @@ -7930,47 +8608,46 @@ "name": "listEgressFirewallRules", "params": [ { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of IP address of the firewall services", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, @@ -7978,23 +8655,32 @@ "description": "Lists rule with the specified ID.", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "the network ID for the egress firewall services", @@ -8005,12 +8691,11 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "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.", @@ -8018,21 +8703,19 @@ "name": "listall", "required": false, "type": "boolean" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the public ip address for the firewall rule", @@ -8044,39 +8727,44 @@ "name": "icmpcode", "type": "integer" }, + {}, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, - {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -8085,23 +8773,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -8115,32 +8803,31 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, - {}, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, { "description": "the starting port of firewall rule's port range", "name": "startport", "type": "integer" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -8149,28 +8836,19 @@ "type": "boolean" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" } ] @@ -8181,23 +8859,32 @@ "name": "listClustersMetrics", "params": [ { - "description": "", + "description": "lists clusters by Pod ID", "length": 255, - "name": "page", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "lists clusters by hypervisor type", + "description": "lists clusters by allocation state", "length": 255, - "name": "hypervisor", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "lists clusters by cluster type", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "clustertype", + "name": "id", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -8209,168 +8896,112 @@ "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by Zone ID", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "lists clusters by cluster type", "length": 255, - "name": "pagesize", + "name": "clustertype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "", "length": 255, - "name": "showcapacities", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "lists clusters by allocation state", + "description": "CPU arch of the clusters", "length": 255, - "name": "allocationstate", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists clusters by Zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists clusters by the cluster name", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "name", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "lists clusters by the cluster name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "CPU arch of the clusters", + "description": "the name of the storage access group", "length": 255, - "name": "arch", + "name": "storageaccessgroup", "required": false, - "since": "4.20.1", + "since": "4.21.0", "type": "string" } ], "related": "", "response": [ { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", - "type": "string" - }, - { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the cluster name", + "name": "name", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the type of the cluster", "name": "clustertype", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", - "type": "string" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "state of the cluster", - "name": "state", - "type": "string" - }, - { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" - }, - { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", - "type": "string" - }, - { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" - }, { "description": "the cluster ID", "name": "id", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { @@ -8379,23 +9010,13 @@ "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -8408,8 +9029,13 @@ "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -8423,14 +9049,14 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the Cluster ID", @@ -8438,24 +9064,19 @@ "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { "description": "the Pod ID", @@ -8463,38 +9084,52 @@ "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Pod name", + "name": "podname", + "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" }, {}, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "DRS imbalance for the cluster", + "name": "drsimbalance", "type": "string" }, { - "description": "running / total hosts in the cluster", - "name": "hosts", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, - {}, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { @@ -8502,29 +9137,70 @@ "name": "resourcedetails", "type": "map" }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", + "type": "string" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, { "description": "cpu usage notification threshold exceeded", "name": "cputhreshold", "type": "boolean" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "running / total hosts in the cluster", + "name": "hosts", + "type": "string" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "DRS imbalance for the cluster", - "name": "drsimbalance", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + {}, + { + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { @@ -8533,268 +9209,345 @@ "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "state of the cluster", + "name": "state", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" } ], "since": "4.9.3" }, { - "description": "Lists objects at specified path on a storage pool.", + "description": "Creates a user-defined VM backup schedule", "isasync": false, - "name": "listStoragePoolObjects", + "name": "createBackupSchedule", "params": [ { - "description": "", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "timezone", + "required": true, + "type": "string" }, { - "description": "", + "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)", "length": 255, - "name": "pagesize", + "name": "schedule", + "required": true, + "type": "string" + }, + { + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", + "length": 255, + "name": "quiescevm", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { - "description": "id of the storage pool", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "intervaltype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "path to list on storage pool", + "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.", "length": 255, - "name": "path", + "name": "maxbackups", "required": false, - "type": "string" + "since": "4.21.0", + "type": "integer" }, { - "description": "List by keyword", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "virtualmachineid", + "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", + "required": true, + "type": "uuid" } ], - "related": "listImageStoreObjects", + "related": "updateBackupSchedule,listBackups", "response": [ { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", - "type": "string" + "description": "backup date", + "name": "created", + "type": "date" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "backup size in bytes", + "name": "size", + "type": "long" }, { - "description": "Name of the data store object.", + "description": "name of the backup", "name": "name", "type": "string" }, { - "description": "Is it a directory.", - "name": "isdirectory", + "description": "domain id", + "name": "domainid", + "type": "string" + }, + { + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", "type": "boolean" }, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "account name", + "name": "account", + "type": "string" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "backup offering id", + "name": "backupofferingid", "type": "string" }, - {}, + { + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id", + "name": "zoneid", "type": "string" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "zone name", + "name": "zone", "type": "string" }, {}, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "backed up volumes", + "name": "volumes", "type": "string" }, { - "description": "Template Name associated with the data store object.", - "name": "templatename", + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "backup type", + "name": "type", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Creates a user-defined VM backup schedule", - "isasync": false, - "name": "createBackupSchedule", - "params": [ + }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": true, + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "backup status", + "name": "status", + "type": "status" }, { - "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)", - "length": 255, - "name": "schedule", - "required": true, + "description": "ID of the VM backup", + "name": "id", "type": "string" - } - ], - "related": "updateBackupSchedule,listBackups", - "response": [ + }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "domain name", + "name": "domain", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" }, - {}, { - "description": "ID of the VM backup", - "name": "id", + "description": "description for the backup", + "name": "description", "type": "string" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone id", - "name": "zoneid", + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "backup date", - "name": "created", - "type": "date" - }, + "description": "account id", + "name": "accountid", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Lists objects at specified path on a storage pool.", + "isasync": false, + "name": "listStoragePoolObjects", + "params": [ { - "description": "backup type", - "name": "type", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "domain id", - "name": "domainid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "id of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + }, + { + "description": "path to list on storage pool", + "length": 255, + "name": "path", + "required": false, "type": "string" }, { - "description": "zone name", - "name": "zone", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "listImageStoreObjects", + "response": [ + { + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, + {}, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "Template Name associated with the data store object.", + "name": "templatename", "type": "string" }, { - "description": "account name", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "external backup id", - "name": "externalid", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "backed up volumes", - "name": "volumes", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { - "description": "backup size in bytes", + "description": "Size is in Bytes.", "name": "size", "type": "long" }, { - "description": "domain name", - "name": "domain", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", + "type": "string" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" + }, + {} ], - "since": "4.14.0" + "since": "4.19.0" }, { "description": "Lists secondary staging stores.", @@ -8802,11 +9555,11 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "", + "description": "the staging store provider", "length": 255, - "name": "page", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the staging store", @@ -8817,16 +9570,9 @@ "type": "uuid" }, { - "description": "the name of the staging store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the staging store protocol", + "description": "List by keyword", "length": 255, - "name": "protocol", + "name": "keyword", "required": false, "type": "string" }, @@ -8846,37 +9592,48 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the staging store protocol", "length": 255, - "name": "keyword", + "name": "protocol", "required": false, "type": "string" }, { - "description": "the staging store provider", + "description": "the name of the staging store", "length": 255, - "name": "provider", + "name": "name", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ + {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, - {}, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -8884,10 +9641,11 @@ "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "the current status of the latest async job acting on this object", @@ -8895,44 +9653,39 @@ "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" } ], "since": "4.2.0" @@ -8954,103 +9707,8 @@ "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { @@ -9058,66 +9716,30 @@ "name": "templatename", "type": "string" }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - {}, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, { "description": "the ID of the corresponding guest network", "name": "guestnetworkid", "type": "string" }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, {}, { - "description": "the project name of the address", - "name": "project", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { @@ -9125,93 +9747,108 @@ "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, { "description": "IP addresses associated with NIC found for unmanaged VM", "name": "ipaddresses", "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -9225,101 +9862,167 @@ "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" } ], "type": "set" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, { "description": "the state of the router", "name": "state", "type": "state" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { @@ -9327,29 +10030,89 @@ "name": "isredundantrouter", "type": "boolean" }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, { "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { @@ -9357,14 +10120,14 @@ "name": "healthcheckresults", "response": [ { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" }, { "description": "the type of the health check - basic or advanced", @@ -9372,9 +10135,9 @@ "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { "description": "result of the health check", @@ -9385,44 +10148,34 @@ "type": "list" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the version of template", - "name": "version", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" } ] }, @@ -9432,66 +10185,66 @@ "name": "resetConfiguration", "params": [ { - "description": "the ID of the Account to reset the parameter value for corresponding account", + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the ID of the Domain to reset the parameter value for corresponding domain", + "description": "the ID of the Zone to reset the parameter value for corresponding zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "description": "the name of the configuration", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "imagestoreid", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "description": "the ID of the Domain to reset the parameter value for corresponding domain", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", + "description": "the ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "the name of the configuration", + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" } ], "related": "listConfigurations,updateConfiguration", "response": [ { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { @@ -9500,18 +10253,18 @@ "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { @@ -9520,50 +10273,50 @@ "type": "long" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the component of the configuration", + "name": "component", + "type": "string" }, + {}, + {}, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the default value of the configuration", "name": "defaultvalue", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { @@ -9572,9 +10325,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" } ], "since": "4.16.0" @@ -9585,12 +10338,20 @@ "name": "createAutoScalePolicy", "params": [ { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "duration", - "required": true, + "name": "quiettime", + "required": false, "type": "integer" }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "length": 255, + "name": "conditionids", + "related": "createCondition,listConditions", + "required": true, + "type": "list" + }, { "description": "the name of the autoscale policy", "length": 255, @@ -9607,37 +10368,33 @@ "type": "string" }, { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", - "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" - }, - { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", + "name": "duration", "required": true, - "type": "list" + "type": "integer" } ], "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ - {}, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" + }, + { + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, {}, @@ -9647,23 +10404,19 @@ "type": "integer" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - }, - { - "description": "name of the autoscale policy", - "name": "name", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { @@ -9672,29 +10425,29 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -9714,26 +10467,26 @@ ], "response": [ {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -9744,42 +10497,42 @@ "params": [], "related": "", "response": [ - { - "description": "the name of the active usage server", - "name": "hostname", - "type": "string" - }, { "description": "the last time a usage job successfully completed", "name": "lastsuccessfuljob", "type": "date" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the time these statistics were collected", "name": "collectiontime", "type": "date" }, { - "description": "the state of the usage server", - "name": "state", - "type": "state" + "description": "the last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" + }, + {}, + { + "description": "the name of the active usage server", + "name": "hostname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", - "type": "date" + "description": "the state of the usage server", + "name": "state", + "type": "state" } ], "since": "4.17.0" @@ -9799,13 +10552,17 @@ } ], "response": [ - {}, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -9816,11 +10573,7 @@ "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.11" }, @@ -9830,112 +10583,85 @@ "name": "cleanVMReservations", "params": [], "response": [ + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Lists object storage pools.", - "isasync": false, - "name": "listObjectStoragePools", + "description": "Updates Routing firewall rule with specified ID", + "isasync": true, + "name": "updateRoutingFirewallRule", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the storage pool", + "description": "the ID of the Routing firewall rule", "length": 255, "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", - "required": false, + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, "type": "uuid" }, { - "description": "the name of the object store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the object store provider", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "provider", + "name": "customid", "required": false, + "since": "4.4", "type": "string" } ], - "related": "addObjectStoragePool,updateObjectStoragePool", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "response": [ - {}, { - "description": "the ID of the object store", - "name": "id", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the url of the object store", - "name": "url", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -9943,57 +10669,24 @@ "type": "integer" }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the name of the object store", - "name": "name", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Updates Routing firewall rule with specified ID", - "isasync": true, - "name": "updateRoutingFirewallRule", - "params": [ - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "the ID of the Routing firewall rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" - } - ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", - "response": [ - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -10001,33 +10694,33 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -10036,23 +10729,23 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], @@ -10064,84 +10757,149 @@ "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the starting port of port forwarding rule's public port range", "name": "publicport", "type": "string" - }, - {}, + } + ], + "since": "4.20.0" + }, + { + "description": "Lists object storage pools.", + "isasync": false, + "name": "listObjectStoragePools", + "params": [ { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the name of the object store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the object store provider", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", + "required": false, + "type": "uuid" + } + ], + "related": "addObjectStoragePool,updateObjectStoragePool", + "response": [ + { + "description": "the ID of the object store", + "name": "id", + "type": "string" + }, + { + "description": "the url of the object store", + "name": "url", + "type": "string" + }, + { + "description": "the name of the object store", + "name": "name", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" + }, + { + "description": "the object store currently used size", + "name": "storageused", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the provider name of the object store", + "name": "providername", + "type": "string" + }, + {}, + { + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.20.0" + "since": "4.19.0" }, { "description": "create secondary staging store.", @@ -10149,12 +10907,11 @@ "name": "createSecondaryStagingStore", "params": [ { - "description": "the Zone ID for the staging store", + "description": "the details for the staging store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { "description": "the URL for the staging store", @@ -10164,62 +10921,54 @@ "type": "string" }, { - "description": "the scope of the staging store: zone only for now", + "description": "the staging store provider name", "length": 255, - "name": "scope", + "name": "provider", "required": false, "type": "string" }, { - "description": "the staging store provider name", + "description": "the scope of the staging store: zone only for now", "length": 255, - "name": "provider", + "name": "scope", "required": false, "type": "string" }, { - "description": "the details for the staging store", + "description": "the Zone ID for the staging store", "length": 255, - "name": "details", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "map" + "type": "uuid" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the image store", - "name": "id", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the url of the image store", + "name": "url", "type": "string" }, { @@ -10228,36 +10977,45 @@ "type": "scopetype" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the protocol of the image store", + "name": "protocol", "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" } ] }, @@ -10276,29 +11034,101 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "Run the custom action", + "isasync": true, + "name": "runCustomAction", + "params": [ + { + "description": "Parameters in key/value pairs using format parameters[i].keyname=keyvalue. Example: parameters[0].endpoint.url=urlvalue", + "length": 255, + "name": "parameters", + "required": false, + "type": "map" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "ID of the custom action", + "length": 255, + "name": "customactionid", + "related": "addCustomAction,listCustomActions", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the instance", + "length": 255, + "name": "resourceid", + "required": true, + "type": "string" + }, + { + "description": "Type of the resource", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Result of the action execution", + "name": "result", + "type": "map" + }, + { + "description": "Whether custom action succeed or not", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the action", + "name": "id", "type": "string" }, - {}, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Name of the action", + "name": "name", + "type": "string" } - ] + ], + "since": "4.21.0" }, { "description": "Updates load balancer health check policy", @@ -10332,45 +11162,59 @@ ], "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the domain ID of the HealthCheck policy", "name": "domainid", "type": "string" }, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, + {}, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, { "description": "Time to wait when receiving a response from the health check", "name": "responsetime", "type": "int" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", "type": "int" }, { @@ -10378,49 +11222,35 @@ "name": "state", "type": "string" }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, { "description": "Amount of time between health checks", "name": "healthcheckinterval", "type": "int" }, + { + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" + }, { "description": "the description of the healthcheck policy", "name": "description", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, + { + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" } ], "type": "list" }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - } + {} ], "since": "4.4" }, @@ -10454,24 +11284,30 @@ ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", "response": [ + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { @@ -10479,19 +11315,13 @@ "name": "network", "type": "list" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - {}, { "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" - } + }, + {}, + {} ] }, { @@ -10499,14 +11329,6 @@ "isasync": true, "name": "createLoadBalancerRule", "params": [ - { - "description": "the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", - "length": 255, - "name": "cidrlist", - "required": false, - "since": "4.18.0.0", - "type": "list" - }, { "description": "the description of the load balancer rule", "length": 4096, @@ -10515,11 +11337,12 @@ "type": "string" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "public IP address ID from where the network traffic will be load balanced from", @@ -10530,11 +11353,12 @@ "type": "uuid" }, { - "description": "the public port from where the network traffic will be load balanced from", + "description": "the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", "length": 255, - "name": "publicport", - "required": true, - "type": "integer" + "name": "cidrlist", + "required": false, + "since": "4.18.0.0", + "type": "list" }, { "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", @@ -10544,28 +11368,41 @@ "type": "string" }, { - "description": "the domain ID associated with the load balancer", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "openfirewall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "fordisplay", + "name": "publicport", + "required": true, + "type": "integer" + }, + { + "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "name of the load balancer rule", "length": 255, - "name": "algorithm", + "name": "name", "required": true, "type": "string" }, + { + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", "length": 255, @@ -10575,19 +11412,19 @@ "type": "uuid" }, { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "description": "the domain ID associated with the load balancer", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" + "name": "algorithm", + "required": true, + "type": "string" }, { "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", @@ -10595,46 +11432,70 @@ "name": "privateport", "required": true, "type": "integer" - }, - { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, {}, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, + {}, { "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { @@ -10642,6 +11503,41 @@ "name": "publicip", "type": "string" }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the list of resource tags associated with load balancer", "name": "tags", @@ -10652,43 +11548,43 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -10697,93 +11593,27 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, - {}, { "description": "the protocol of the loadbalanacer rule", "name": "protocol", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" } ] }, @@ -10804,9 +11634,9 @@ "related": "quotaConfigureEmail", "response": [ { - "description": "The template's name.", - "name": "templatename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Whether the template is enabled.", @@ -10814,12 +11644,10 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The template's name.", + "name": "templatename", + "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -10830,6 +11658,8 @@ "name": "minbalance", "type": "double" }, + {}, + {}, { "description": "The configured account's id.", "name": "account", @@ -10855,8 +11685,13 @@ "related": "listVsphereStoragePolicies", "response": [ { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { @@ -10865,19 +11700,14 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -10885,12 +11715,12 @@ "name": "name", "type": "string" }, + {}, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" - }, - {} + } ] }, { @@ -10908,6 +11738,7 @@ } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -10915,20 +11746,19 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.20.0" @@ -10950,9 +11780,9 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { "description": "the out-of-band management interface password", @@ -10965,8 +11795,8 @@ "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { @@ -10975,8 +11805,8 @@ "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { @@ -10985,9 +11815,14 @@ "type": "boolean" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { "description": "the out-of-band management interface address", @@ -10995,27 +11830,22 @@ "type": "string" }, {}, + {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the operation result description", + "name": "description", "type": "string" - }, - {} + } ], "since": "4.9.0" }, @@ -11024,36 +11854,60 @@ "isasync": true, "name": "createBackup", "params": [ + { + "description": "the name of the backup", + "length": 255, + "name": "name", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", + "length": 255, + "name": "quiescevm", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "the description for the backup", + "length": 255, + "name": "description", + "required": false, + "since": "4.21.0", + "type": "string" + }, { "description": "ID of the VM", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "uuid" } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], @@ -11064,6 +11918,13 @@ "isasync": true, "name": "stopSystemVm", "params": [ + { + "description": "Force stop the VM (vm 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 VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "The ID of the system virtual machine", "length": 255, @@ -11071,102 +11932,89 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "required": true, "type": "uuid" - }, - { - "description": "Force stop the VM (vm 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 VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - {}, - { - "description": "the state of the system VM", - "name": "state", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { "description": "the hypervisor on which the template runs", @@ -11174,105 +12022,100 @@ "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, + {}, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, - {}, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the network domain for the system VM", @@ -11280,24 +12123,25 @@ "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, + {}, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" } ] }, @@ -11310,29 +12154,29 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": true, "type": "uuid" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -11346,17 +12190,17 @@ "name": "updateVPC", "params": [ { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "the id of the VPC", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { - "description": "the display text of the VPC", + "description": "the name of the VPC", "length": 255, - "name": "displaytext", + "name": "name", "required": false, "type": "string" }, @@ -11369,214 +12213,124 @@ "type": "integer" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "sourcenatipaddress", + "name": "fordisplay", "required": false, - "since": "4.19", - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the name of the VPC", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", "length": 255, - "name": "customid", + "name": "sourcenatipaddress", "required": false, - "since": "4.4", + "since": "4.19", "type": "string" }, { - "description": "the id of the VPC", + "description": "the display text of the VPC", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" + "name": "displaytext", + "required": false, + "type": "string" } ], "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, { "description": "an alternate display text of the VPC.", "name": "displaytext", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, {}, { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, + {}, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", "type": "set" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { @@ -11584,8 +12338,8 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -11593,11 +12347,6 @@ "name": "key", "type": "string" }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -11609,18 +12358,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -11628,58 +12377,67 @@ "name": "projectid", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { @@ -11688,14 +12446,9 @@ "type": "boolean" }, { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the cidr the VPC", @@ -11703,23 +12456,89 @@ "type": "string" }, { - "description": "the name of the VPC", - "name": "name", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], "type": "list" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { @@ -11728,9 +12547,34 @@ "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", "type": "boolean" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" } ] }, @@ -11740,83 +12584,83 @@ "name": "listIpv6FirewallRules", "params": [ { - "description": "Lists ipv6 firewall rule with the specified ID", + "description": "list ipv6 firewall rules by network ID", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "traffictype", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "list ipv6 firewall rules by traffic type - ingress or egress", "length": 255, - "name": "pagesize", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list ipv6 firewall rules by network ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "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.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Lists ipv6 firewall rule with the specified ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, "type": "uuid" }, @@ -11828,95 +12672,38 @@ "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, { "description": "the public ip address id for the port forwarding rule", "name": "ipaddressid", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { @@ -11924,72 +12711,129 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { "description": "the VM display name for the port forwarding rule", "name": "virtualmachinedisplayname", "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + {}, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" } ] }, @@ -11998,6 +12842,21 @@ "isasync": false, "name": "listVMSchedule", "params": [ + { + "description": "ID of VM schedule", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "ID of the VM for which schedule is to be defined", + "length": 255, + "name": "virtualmachineid", + "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", + "required": true, + "type": "uuid" + }, { "description": "ID of VM schedule", "length": 255, @@ -12007,9 +12866,9 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "Action taken by schedule", "length": 255, - "name": "keyword", + "name": "action", "required": false, "type": "string" }, @@ -12021,99 +12880,84 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Action taken by schedule", + "description": "", "length": 255, - "name": "action", + "name": "pagesize", "required": false, + "type": "integer" + } + ], + "related": "createVMSchedule,updateVMSchedule", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, { - "description": "ID of VM schedule", - "length": 255, + "description": "VM schedule is enabled", "name": "enabled", - "required": false, "type": "boolean" - } - ], - "related": "createVMSchedule,updateVMSchedule", - "response": [ + }, { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, { "description": "Action", "name": "action", "type": "action" }, { - "description": "Date when the schedule was created", - "name": "created", + "description": "Date from which the schedule is active", + "name": "startdate", "type": "date" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" - }, + {}, { "description": "Description of VM schedule", "name": "description", "type": "string" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" - }, - {} + } ], "since": "4.19.0" }, @@ -12123,26 +12967,25 @@ "name": "patchSystemVm", "params": [ { - "description": "patches systemVM - CPVM/SSVM with the specified ID", + "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", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "forced", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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", + "description": "patches systemVM - CPVM/SSVM with the specified ID", "length": 255, - "name": "forced", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "type": "boolean" + "type": "uuid" } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -12150,394 +12993,592 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {} ], "since": "4.17.0" }, { - "description": "Lists volume metrics", - "isasync": false, - "name": "listVolumesMetrics", + "description": "Add nodes as workers to an existing CKS cluster. ", + "isasync": true, + "name": "addNodesToKubernetesCluster", "params": [ { - "description": "the pod id the disk volume belongs to", + "description": "(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "mountcksisoonvr", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster", + "required": true, + "since": "4.21.0", + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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)", "length": 255, - "name": "displayvolume", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "nodeids", + "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", + "required": true, + "type": "list" }, { - "description": "the type of disk volume", + "description": "(optional) indicates if the node is marked for manual upgrade and excluded from the Kubernetes cluster upgrade operation", "length": 255, - "name": "type", + "name": "manualupgrade", "required": false, + "type": "boolean" + } + ], + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "response": [ + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "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.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": false, - "since": "4.9", - "type": "list" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, + {}, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.19.1", - "type": "uuid" + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", - "length": 255, - "name": "state", - "required": false, + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "list volumes by disk offering", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the ID of the storage pool, available to ROOT admin only", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.3", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": false, - "type": "uuid" + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "listsystemvms", - "required": false, - "since": "4.18", - "type": "boolean" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" }, { - "description": "list only volumes that are encrypted", - "length": 255, - "name": "isencrypted", - "required": false, - "since": "4.19.1", - "type": "boolean" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "list volumes on specified host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", "type": "map" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, - {}, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "the date the disk volume was created", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", + "type": "string" + }, + { + "description": "the date when this Kubernetes cluster was created", "name": "created", "type": "date" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, + {}, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Lists volume metrics", + "isasync": false, + "name": "listVolumesMetrics", + "params": [ + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvolume", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.19.1", + "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list volumes by disk offering", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "the ID of the storage pool, available to ROOT admin only", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.3", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the IDs of the volumes, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "since": "4.9", + "type": "list" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" + }, + { + "description": "the pod id the disk volume belongs to", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" + }, + { + "description": "the type of disk volume", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "name of the disk volume", + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "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", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list only volumes that are encrypted", + "length": 255, + "name": "isencrypted", + "required": false, + "since": "4.19.1", + "type": "boolean" + }, + { + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the disk volume", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { @@ -12546,266 +13587,353 @@ "type": "map" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, { "description": "the path of the volume", "name": "path", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, + {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, + {}, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" } ], "since": "4.9.3" @@ -12832,18 +13960,18 @@ ], "related": "", "response": [ - { - "description": "Map of all possible details and their possible list of values", - "name": "details", - "type": "map" - }, - {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "Map of all possible details and their possible list of values", + "name": "details", + "type": "map" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -12857,6 +13985,14 @@ "isasync": false, "name": "listSslCerts", "params": [ + { + "description": "Load balancer rule ID", + "length": 255, + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": false, + "type": "uuid" + }, { "description": "Project that owns the SSL certificate", "length": 255, @@ -12880,83 +14016,75 @@ "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" - }, - { - "description": "Load balancer rule ID", - "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", - "required": false, - "type": "uuid" } ], "related": "uploadSslCert", "response": [ { - "description": "certificate", - "name": "certificate", + "description": "certificate chain", + "name": "certchain", "type": "string" }, - {}, { - "description": "account for the certificate", - "name": "account", - "type": "string" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, - {}, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the certificate", + "name": "projectid", + "type": "string" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "name", + "name": "name", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "account for the certificate", + "name": "account", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, + {}, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, + {}, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name", - "name": "name", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -12967,50 +14095,48 @@ "name": "listPrivateGateways", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list gateways by vpc", + "description": "list gateways by state", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list private gateway by id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", "required": false, "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list private gateway by id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "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.", + "description": "list gateways by ip address", "length": 255, - "name": "listall", + "name": "ipaddress", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -13019,13 +14145,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "list gateways by vlan", "length": 255, @@ -13034,76 +14153,80 @@ "type": "string" }, { - "description": "list gateways by ip address", + "description": "", "length": 255, - "name": "ipaddress", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list gateways by state", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "state", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list gateways by vpc", "length": 255, - "name": "keyword", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ + {}, { - "description": "the gateway", - "name": "gateway", - "type": "string" + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, + {}, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the project name of the private gateway", - "name": "project", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, - {}, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { @@ -13112,24 +14235,24 @@ "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "VPC name the private gateway belongs to", + "name": "vpcname", + "type": "string" }, { "description": "the name of the Network associated with this private gateway", @@ -13137,43 +14260,48 @@ "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the id of the private gateway", "name": "id", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { @@ -13182,13 +14310,13 @@ "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", "type": "string" } ] @@ -13198,6 +14326,13 @@ "isasync": true, "name": "updateVmNicIp", "params": [ + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, { "description": "the ID of the nic to which you want to assign private IP", "length": 255, @@ -13205,127 +14340,58 @@ "related": "listNics", "required": true, "type": "uuid" - }, + } + ], + "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", + "response": [ { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "response": [ - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - {}, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, { "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { @@ -13334,33 +14400,13 @@ "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -13369,84 +14415,59 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { "description": "the name of the host for the virtual machine", @@ -13454,98 +14475,48 @@ "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, { "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { @@ -13553,47 +14524,67 @@ "name": "securitygroup", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -13601,23 +14592,28 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -13626,13 +14622,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -13641,46 +14637,46 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], "type": "set" }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -13695,34 +14691,29 @@ "name": "project", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -13731,57 +14722,47 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -13792,33 +14773,33 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -13827,26 +14808,41 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -13862,116 +14858,96 @@ ], "type": "set" }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -13980,13 +14956,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -13995,198 +14971,163 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", + "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" } ], "type": "set" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "the name of the corresponding network", @@ -14194,23 +15135,28 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -14219,34 +15165,34 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "ID of the VLAN/VNI if available", @@ -14254,220 +15200,392 @@ "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" - } - ] - }, - { - "description": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", - "params": [ + }, { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + {}, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + } + ] + }, + { + "description": "Starts an existing internal lb vm.", + "isasync": true, + "name": "startInternalLoadBalancerVM", + "params": [ + { + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ { "description": "the ID of the corresponding network", "name": "networkid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { "description": "the ID of the nic", @@ -14475,18 +15593,28 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -14495,51 +15623,96 @@ "type": "list" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, { "description": "name of the vpc to which the nic belongs", "name": "vpcname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" } ], "type": "set" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { @@ -14548,157 +15721,134 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" }, - {}, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { "description": "the name of the corresponding guest network", "name": "guestnetworkname", "type": "string" }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, { "description": "the Zone name for the router", "name": "zonename", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { "description": "CPU arch of the router", @@ -14706,48 +15856,92 @@ "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + {}, + { + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { @@ -14756,49 +15950,43 @@ "type": "boolean" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account associated with the router", + "name": "account", "type": "string" }, - {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" } ] @@ -14808,29 +15996,6 @@ "isasync": false, "name": "updateDiskOffering", "params": [ - { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "state of the disk offering", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, { "description": "length (in seconds) of the burst", "length": 255, @@ -14839,14 +16004,6 @@ "since": "4.15", "type": "long" }, - { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "since": "4.15", - "type": "long" - }, { "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, @@ -14863,31 +16020,25 @@ "type": "string" }, { - "description": "sort key of the disk offering, integer", + "description": "length (in seconds) of the burst", "length": 255, - "name": "sortkey", + "name": "byteswriteratemaxlength", "required": false, - "type": "integer" + "since": "4.15", + "type": "long" }, { - "description": "updates alternate display text of the disk offering with this value", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 4096, - "name": "displaytext", + "name": "domainid", "required": false, + "since": "4.13", "type": "string" }, { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "burst requests read rate of the disk offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "iopsreadratemax", + "name": "byteswriterate", "required": false, "since": "4.15", "type": "long" @@ -14901,9 +16052,9 @@ "type": "long" }, { - "description": "updates name of the disk offering with this value", + "description": "state of the disk offering", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, @@ -14916,49 +16067,55 @@ "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "updates name of the disk offering with this value", "length": 255, - "name": "iopswriterate", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the cache mode to use for this disk offering", + "length": 255, + "name": "cachemode", "required": false, "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "updates alternate display text of the disk offering with this value", "length": 4096, - "name": "domainid", + "name": "displaytext", "required": false, - "since": "4.13", "type": "string" }, { - "description": "the cache mode to use for this disk offering", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", "length": 255, - "name": "cachemode", + "name": "tags", "required": false, "since": "4.15", "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "iopsreadrate", "required": false, "since": "4.15", "type": "long" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "length (in seconds) of the burst", "length": 255, - "name": "tags", + "name": "bytesreadratemaxlength", "required": false, "since": "4.15", - "type": "string" + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "bytesreadrate", "required": false, "since": "4.15", "type": "long" @@ -14971,6 +16128,13 @@ "since": "4.15", "type": "long" }, + { + "description": "sort key of the disk offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, { "description": "burst bytes write rate of the disk offering", "length": 255, @@ -14978,54 +16142,83 @@ "required": false, "since": "4.15", "type": "long" + }, + { + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "io requests write rate of the disk offering", + "length": 255, + "name": "iopswriterate", + "required": false, + "since": "4.15", + "type": "long" } ], "related": "createDiskOffering,listDiskOfferings", "response": [ { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, + { + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" + }, { "description": "the size of the disk offering in GB", "name": "disksize", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "unique ID of the disk offering", - "name": "id", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { "description": "Whether disks using this offering will be encrypted on primary storage", @@ -15033,18 +16226,25 @@ "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "the name of the disk offering", - "name": "name", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, + {}, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { @@ -15053,14 +16253,9 @@ "type": "long" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", @@ -15068,25 +16263,19 @@ "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - {}, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "state of the disk offering", + "name": "state", + "type": "string" }, { "description": "the min iops of the disk offering", @@ -15094,14 +16283,9 @@ "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" - }, - { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -15109,80 +16293,84 @@ "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "state of the disk offering", - "name": "state", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", "type": "boolean" }, - {}, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" } ] }, @@ -15198,13 +16386,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -15217,7 +16398,7 @@ "description": "the IDs of the VMs to remove from the cluster", "length": 255, "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "list" }, @@ -15227,20 +16408,27 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", @@ -15249,14 +16437,14 @@ }, {}, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.19.0" @@ -15267,43 +16455,43 @@ "name": "deleteTungstenFabricLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric logical router", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "logicalrouteruuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric logical router", + "description": "the ID of zone", "length": 255, - "name": "logicalrouteruuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -15312,13 +16500,6 @@ "isasync": true, "name": "resetVpnConnection", "params": [ - { - "description": "an optional account for connection. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", "length": 255, @@ -15327,6 +16508,13 @@ "required": false, "type": "uuid" }, + { + "description": "an optional account for connection. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "id of vpn connection", "length": 255, @@ -15343,44 +16531,35 @@ "name": "esplifetime", "type": "long" }, + {}, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", - "type": "string" - }, - { - "description": "the domain id of the owner", - "name": "domainid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "State of vpn connection", - "name": "state", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { @@ -15389,18 +16568,13 @@ "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { @@ -15408,42 +16582,41 @@ "name": "esppolicy", "type": "string" }, + {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the project id", - "name": "projectid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, - {}, - {}, { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the domain name of the owner", @@ -15451,14 +16624,19 @@ "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the owner", + "name": "account", + "type": "string" }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", @@ -15466,19 +16644,29 @@ "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" } ] }, @@ -15488,56 +16676,56 @@ "name": "listKubernetesClusters", "params": [ { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "clustertype", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.19.0", - "type": "string" + "type": "uuid" }, { - "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "clustertype", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "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.", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "listall", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -15547,31 +16735,31 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "state of the Kubernetes cluster", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the Kubernetes cluster", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" } @@ -15579,29 +16767,29 @@ "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { "description": "the list of virtualmachine associated with this Kubernetes cluster", @@ -15609,64 +16797,73 @@ "type": "list" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, - {}, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { @@ -15674,29 +16871,25 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, { "description": "Public IP Address of the cluster", "name": "ipaddress", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, + {}, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { @@ -15705,60 +16898,75 @@ "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" }, + {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" + }, + { + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", + "type": "string" + }, + { + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, - {}, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { "description": "the state of the Kubernetes cluster", @@ -15766,9 +16974,39 @@ "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -15778,18 +17016,12 @@ "name": "createAutoScaleVmGroup", "params": [ { - "description": "the frequency in which the performance counters to be collected", - "length": 255, - "name": "interval", - "required": false, - "type": "integer" - }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "the ID of the load balancer rule", "length": 255, - "name": "minmembers", + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, - "type": "integer" + "type": "uuid" }, { "description": "the name of the autoscale vmgroup", @@ -15800,48 +17032,54 @@ "type": "string" }, { - "description": "list of scaledown autoscale policies", + "description": "the frequency in which the performance counters to be collected", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "interval", + "required": false, + "type": "integer" + }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "length": 255, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": true, - "type": "list" + "type": "uuid" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", "length": 255, - "name": "maxmembers", + "name": "minmembers", "required": true, "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "maxmembers", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "list of scaleup autoscale policies", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "scaleuppolicyids", + "name": "scaledownpolicyids", "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, "type": "list" @@ -15850,50 +17088,56 @@ "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the public port", - "name": "publicport", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + {}, + { + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { "description": "true if the entity/resource has annotations", @@ -15901,8 +17145,28 @@ "type": "boolean" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -15911,8 +17175,18 @@ "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" + }, + { + "description": "the account owning the vm group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { @@ -15920,75 +17194,147 @@ "name": "minmembers", "type": "int" }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" + }, + { + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" + }, + { + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, { "description": "the project name of the vm group", "name": "project", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the public port", + "name": "publicport", "type": "string" + } + ] + }, + { + "description": "Change the BGP peers for a VPC.", + "isasync": true, + "name": "changeBgpPeersForVpc", + "params": [ + { + "description": "UUID of the VPC which the Bgp Peers are associated to.", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "required": false, + "type": "list" + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "response": [ + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the account of the bgp peer", + "name": "account", + "type": "string" }, + {}, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the date when this vm group was created", + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "password of bgp peer", + "name": "password", + "type": "string" + }, + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "date when this bgp peer was created.", "name": "created", "type": "date" }, - {}, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, + {}, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { @@ -15996,7 +17342,8 @@ "name": "jobid", "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Deletes a load balancer rule.", @@ -16007,22 +17354,12 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -16034,7 +17371,17 @@ "name": "success", "type": "boolean" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -16043,26 +17390,25 @@ "name": "addBaremetalPxePingServer", "params": [ { - "description": "Credentials to reach external pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "password", + "name": "tftpdir", "required": true, "type": "string" }, { - "description": "PING storage server ip", + "description": "Username of PING storage server", "length": 255, - "name": "pingstorageserverip", - "required": true, + "name": "pingcifsusername", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Root directory on PING storage server", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "pingdir", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Pod Id", @@ -16073,23 +17419,24 @@ "type": "uuid" }, { - "description": "URL of the external pxe device", + "description": "the Physical Network ID", "length": 255, - "name": "url", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to reach external pxe device", + "description": "URL of the external pxe device", "length": 255, - "name": "username", + "name": "url", "required": true, "type": "string" }, { - "description": "Root directory on PING storage server", + "description": "PING storage server ip", "length": 255, - "name": "pingdir", + "name": "pingstorageserverip", "required": true, "type": "string" }, @@ -16101,205 +17448,103 @@ "type": "string" }, { - "description": "Username of PING storage server", + "description": "Password of PING storage server", "length": 255, - "name": "pingcifsusername", + "name": "pingcifspassword", "required": false, "type": "string" }, { - "description": "Tftp root directory of PXE server", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "tftpdir", + "name": "password", "required": true, "type": "string" }, { - "description": "Password of PING storage server", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "pingcifspassword", - "required": false, + "name": "username", + "required": true, "type": "string" } ], "related": "", "response": [ - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "type": "string" - }, { "description": "Root directory on PING storage server", "name": "pingdir", "type": "string" }, - { - "description": "device id of ", - "name": "id", - "type": "string" - }, - { - "description": "url", - "name": "url", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "name of the provider", "name": "provider", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - {}, - {}, { "description": "PING storage server ip", "name": "pingstorageserverip", "type": "string" - } - ] - }, - { - "description": "Change the BGP peers for a VPC.", - "isasync": true, - "name": "changeBgpPeersForVpc", - "params": [ - { - "description": "UUID of the VPC which the Bgp Peers are associated to.", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - }, - { - "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", - "length": 255, - "name": "bgppeerids", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", - "required": false, - "type": "list" - } - ], - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", - "response": [ - {}, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" - }, - { - "description": "the domain ID of the bgp peer", - "name": "domainid", - "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" - }, - { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - { - "description": "the account of the bgp peer", - "name": "account", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "url", + "name": "url", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - { - "description": "password of bgp peer", - "name": "password", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "id of the bgp peer", + "description": "device id of ", "name": "id", "type": "string" }, - { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" - }, - { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" - }, - { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.20.0" + {} + ] }, { "description": "list portable IP ranges", "isasync": false, "name": "listPortableIpRanges", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "Id of the portable ip range", @@ -16315,25 +17560,13 @@ "name": "regionid", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "createPortableIpRange", "response": [ { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, {}, @@ -16342,19 +17575,30 @@ "name": "id", "type": "string" }, + { + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" + }, + {}, { "description": "the end ip of the portable IP range", "name": "endip", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { @@ -16362,38 +17606,33 @@ "name": "portableipaddress", "response": [ { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" }, { @@ -16402,34 +17641,33 @@ "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" }, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" - }, - {} + } ] }, { @@ -16441,7 +17679,7 @@ "description": "The ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "uuid" } @@ -16449,15 +17687,10 @@ "related": "", "response": [ { - "description": "the ID of the virtual machine", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Base64 encoded VM user data", "name": "userdata", @@ -16465,11 +17698,16 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.4" }, @@ -16478,14 +17716,6 @@ "isasync": false, "name": "createNetworkPermissions", "params": [ - { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, { "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, @@ -16495,33 +17725,36 @@ "type": "list" }, { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accounts", + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "list" }, { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accountids", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "accounts", "required": false, "type": "list" + }, + { + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" } ], "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -16532,6 +17765,11 @@ "name": "displaytext", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ], "since": "4.17.0" @@ -16562,7 +17800,6 @@ "type": "integer" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -16572,7 +17809,8 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -16599,39 +17837,34 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ID of the vm", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the nic", - "name": "nicid", + "description": "the ID of the secondary private IP addr", + "name": "id", "type": "string" }, { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the network", "name": "networkid", "type": "string" }, - { - "description": "the ID of the secondary private IP addr", - "name": "id", - "type": "string" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the nic", + "name": "nicid", "type": "string" }, { @@ -16639,7 +17872,12 @@ "name": "ipaddress", "type": "string" }, - {} + {}, + { + "description": "the ID of the vm", + "name": "virtualmachineid", + "type": "string" + } ] }, { @@ -16648,20 +17886,11 @@ "name": "quotaTariffUpdate", "params": [ { - "description": "Quota tariff's name", - "length": 65535, - "name": "name", - "required": true, - "since": "4.18.0.0", - "type": "string" - }, - { - "description": "Quota tariff's description. Inform empty to remove the description.", - "length": 65535, - "name": "description", + "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "startdate", "required": false, - "since": "4.18.0.0", - "type": "string" + "type": "date" }, { "description": "The end date of the quota tariff. 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.", @@ -16672,45 +17901,60 @@ "type": "date" }, { - "description": "DEPRECATED. The effective start date on/after which the quota tariff is effective. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "description": "Position in the execution sequence for tariffs of the same type", "length": 255, - "name": "startdate", + "name": "position", "required": false, - "type": "date" + "since": "4.20.0.0", + "type": "integer" }, { - "description": "The quota tariff value of the resource as per the default unit.", + "description": "DEPRECATED. Integer value for the usage type of the resource", "length": 255, - "name": "value", + "name": "usagetype", "required": false, - "type": "double" + "type": "integer" }, { - "description": "Position in the execution sequence for tariffs of the same type", - "length": 255, - "name": "position", + "description": "Quota tariff's description. Inform empty to remove the description.", + "length": 65535, + "name": "description", "required": false, - "since": "4.20.0.0", - "type": "integer" + "since": "4.18.0.0", + "type": "string" }, { - "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", + "description": "Quota tariff's name", "length": 65535, - "name": "activationrule", - "required": false, + "name": "name", + "required": true, "since": "4.18.0.0", "type": "string" }, { - "description": "DEPRECATED. Integer value for the usage type of the resource", + "description": "The quota tariff value of the resource as per the default unit.", "length": 255, - "name": "usagetype", + "name": "value", "required": false, - "type": "integer" + "type": "double" + }, + { + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied. Inform empty to remove the activation rule.", + "length": 65535, + "name": "activationrule", + "required": false, + "since": "4.18.0.0", + "type": "string" } ], "related": "quotaTariffList,quotaTariffCreate", "response": [ + {}, + { + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" + }, { "description": "usageName", "name": "usageName", @@ -16722,6 +17966,21 @@ "type": "string" }, {}, + { + "description": "usage type description", + "name": "usageTypeDescription", + "type": "string" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" + }, + { + "description": "description", + "name": "description", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -16733,70 +17992,49 @@ "type": "string" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "currency", + "name": "currency", + "type": "string" }, { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the tariff", + "name": "id", + "type": "string" }, { "description": "name", "name": "name", "type": "string" }, - { - "description": "description", - "name": "description", - "type": "string" - }, { "description": "when the quota tariff was removed", "name": "removed", "type": "date" }, { - "description": "the ID of the tariff", - "name": "id", - "type": "string" + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" }, { "description": "usageUnit", "name": "usageUnit", "type": "string" }, - { - "description": "currency", - "name": "currency", - "type": "string" - }, { "description": "usageType", "name": "usageType", "type": "int" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" - }, - { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" - }, - { - "description": "usage type description", - "name": "usageTypeDescription", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.7.0" @@ -16816,18 +18054,8 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -16837,6 +18065,16 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -16854,42 +18092,42 @@ "type": "uuid" }, { - "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, - "name": "forced", + "name": "forcedestroylocalstorage", "required": false, "type": "boolean" }, { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "description": "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped", "length": 255, - "name": "forcedestroylocalstorage", + "name": "forced", "required": false, "type": "boolean" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -16914,12 +18152,17 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", @@ -16927,14 +18170,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.16.0.0" @@ -16952,129 +18190,149 @@ "type": "boolean" }, { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", - "type": "integer" - }, - { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", "type": "boolean" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "the min CPU count for the service offering used by the shared filesystem instance", - "name": "sharedfsvmmincpucount", - "type": "integer" + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", + "type": "boolean" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", + "description": "true if dynamically scaling for instances is enabled", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", - "type": "string" + "description": "true if users are allowed to force stop a vm, false otherwise", + "name": "allowuserforcestopvm", + "type": "boolean" }, { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", "type": "boolean" }, { - "description": "true if users are allowed to force stop a vm, false otherwise", - "name": "allowuserforcestopvm", + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", "type": "boolean" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "true if stats are retained for instance disks otherwise false", "name": "instancesdisksstatsretentionenabled", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", + "type": "boolean" + }, + { + "description": "the min CPU count for the service offering used by the shared filesystem instance", + "name": "sharedfsvmmincpucount", + "type": "integer" + }, + { + "description": "the min Ram size for the service offering used by the shared filesystem instance", + "name": "sharedfsvmminramsize", "type": "integer" }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, { "description": "true if region supports elastic load balancer on basic zones", "name": "supportELB", "type": "string" }, + { + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" + }, { "description": "minimum size that can be specified when create disk from disk offering with custom size", "name": "customdiskofferingminsize", "type": "long" }, { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", "type": "integer" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", + "type": "integer" + }, + { + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", "type": "boolean" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" + }, + { + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", "type": "boolean" }, { - "description": "the retention time for Instances stats", - "name": "instancesstatsretentiontime", + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", "type": "integer" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", "type": "boolean" }, + { + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", + "type": "string" + }, { "description": "default page size in the UI for various views, value set in the configurations", "name": "defaultuipagesize", "type": "long" }, { - "description": "the min Ram size for the service offering used by the shared filesystem instance", - "name": "sharedfsvmminramsize", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The path of the extensions directory", + "name": "extensionspath", "type": "string" }, + {}, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", - "type": "boolean" - }, - { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", - "type": "integer" + "description": "version of the cloud stack", + "name": "cloudstackversion", + "type": "string" }, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", + "description": "true if instance lease feature is enabled", + "name": "instanceleaseenabled", "type": "boolean" }, { @@ -17082,21 +18340,16 @@ "name": "userpublictemplateenabled", "type": "boolean" }, + {}, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", "type": "boolean" }, - {}, { - "description": "version of the cloud stack", - "name": "cloudstackversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "true if stats are collected only for user instances, false if system instance stats are also collected", - "name": "instancesstatsuseronly", - "type": "boolean" } ] }, @@ -17116,27 +18369,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -17144,6 +18397,14 @@ "isasync": true, "name": "updateNetworkServiceProvider", "params": [ + { + "description": "network service provider id", + "length": 255, + "name": "id", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "required": true, + "type": "uuid" + }, { "description": "Enabled/Disabled/Shutdown the physical network service provider", "length": 255, @@ -17157,58 +18418,50 @@ "name": "servicelist", "required": false, "type": "list" - }, - { - "description": "network service provider id", - "length": 255, - "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", - "required": true, - "type": "uuid" } ], "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "state of the network provider", - "name": "state", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, + {}, + {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -17224,13 +18477,6 @@ "isasync": true, "name": "checkVolume", "params": [ - { - "description": "parameter to repair the volume, leaks or all are the possible values", - "length": 255, - "name": "repair", - "required": false, - "type": "string" - }, { "description": "The ID of the volume", "length": 255, @@ -17238,125 +18484,56 @@ "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" + }, + { + "description": "parameter to repair the volume, leaks or all are the possible values", + "length": 255, + "name": "repair", + "required": false, + "type": "string" } ], "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - {}, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, { "description": "the display text of the disk offering", "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -17364,8 +18541,13 @@ "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { @@ -17374,24 +18556,24 @@ "type": "integer" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { "description": "IO requests write rate of the disk volume per the disk offering", @@ -17399,102 +18581,92 @@ "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -17503,37 +18675,42 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { "description": "the state of the disk volume", @@ -17541,19 +18718,19 @@ "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "true if volume has delete protection.", @@ -17561,69 +18738,121 @@ "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, + {}, + {}, { "description": "name of the virtual machine", "name": "vmname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { "description": "size of the disk volume", @@ -17631,24 +18860,39 @@ "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { "description": "details for the volume repair result, they may vary for different hypervisors", @@ -17656,16 +18900,25 @@ "type": "map" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, - {} + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + } ], "since": "4.19.1" }, @@ -17675,160 +18928,155 @@ "name": "listManagementServersMetrics", "params": [ { - "description": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", + "description": "include system level stats", "length": 255, - "name": "peers", + "name": "system", + "related": "listManagementServersMetrics", "required": false, - "since": "4.20.1.0", "type": "boolean" }, { - "description": "include system level stats", + "description": "List by keyword", "length": 255, - "name": "system", - "related": "listManagementServersMetrics", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the id of the management server", + "description": "", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the management server", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "the id of the management server", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the management server", + "description": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", "length": 255, - "name": "name", + "name": "peers", "required": false, - "type": "string" + "since": "4.20.1.0", + "type": "boolean" } ], "related": "", "response": [ { - "description": "the java distribution name running the management server process", - "name": "javadistribution", - "type": "string" - }, - { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", + "description": "the number of host agents this Management Server is responsible for", + "name": "agentscount", "type": "long" }, { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" + "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", + "type": "string" }, + {}, { - "description": "the current cpu load", - "name": "cpuload", + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, - {}, { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" + "description": "the number of pending jobs in this Management Server", + "name": "pendingjobscount", + "type": "long" }, { - "description": "Free system memory", - "name": "systemmemoryfree", - "type": "string" + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" }, { - "description": "Total system memory", - "name": "systemmemorytotal", - "type": "string" + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" }, { - "description": "The number of blocked threads", - "name": "threadsblockedcount", + "description": "The number of daemon threads", + "name": "threadsdaemoncount", "type": "integer" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" + "description": "the name of the management server", + "name": "name", + "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the IP Address for this Management Server", - "name": "ipaddress", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, + { + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" + }, { "description": "the ID of the management server", "name": "id", "type": "string" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" - }, - { - "description": "the time these statistics were collected", - "name": "collectiontime", + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", "type": "date" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" + "description": "Free system memory", + "name": "systemmemoryfree", + "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the log files and their usage on disk", + "name": "loginfo", + "type": "string" }, { "description": "the Management Server Peers", @@ -17836,95 +19084,120 @@ "type": "list" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", - "type": "string" - }, - { - "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", - "name": "serviceip", - "type": "string" + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" }, { - "description": "The number of threads", - "name": "threadstotalcount", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the version of the management server", - "name": "version", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" - }, - { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", - "type": "integer" + "description": "the version of the management server", + "name": "version", + "type": "string" }, { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, + {}, { "description": "Amount of memory used", "name": "systemmemoryused", "type": "string" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", + "description": "the number of client sessions active on this Management Server", + "name": "sessions", "type": "long" }, - {}, { - "description": "the name of the management server", - "name": "name", + "description": "the IP Address for this Management Server", + "name": "ipaddress", "type": "string" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the last time this Management Server was started", + "name": "lastserverstart", "type": "date" }, + { + "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" + }, + { + "description": "the agents this Management Server is responsible for", + "name": "agents", + "type": "list" + }, { "description": "Virtual size of the fully loaded process", "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" + }, + { + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" }, { "description": "the number of agents this Management Server is responsible for", "name": "agentcount", "type": "integer" }, + { + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" + }, + { + "description": "the current cpu load", + "name": "cpuload", + "type": "string" + }, { "description": "the system load for user, and system processes and the system idle cycles", "name": "systemcycleusage", "type": "long[]" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", - "type": "string" + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" + }, + { + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" } ], "since": "4.17.0" @@ -17935,53 +19208,53 @@ "name": "removeFromLoadBalancerRule", "params": [ { - "description": "The ID of the load balancer rule", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", - "required": true, - "type": "uuid" + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" }, { "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", "length": 255, "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": false, "type": "list" }, { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "description": "The ID of the load balancer rule", "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -18004,6 +19277,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "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.", "length": 255, @@ -18012,11 +19292,12 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -18025,21 +19306,6 @@ "required": false, "type": "string" }, - { - "description": "list instance groups by ID", - "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list instance groups by name", "length": 255, @@ -18048,10 +19314,10 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list instance groups by ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, "type": "uuid" }, @@ -18061,30 +19327,39 @@ "name": "isrecursive", "required": false, "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "createInstanceGroup,updateInstanceGroup", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the instance group", - "name": "id", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { "description": "the account owning the instance group", "name": "account", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name of the instance group", + "name": "domain", + "type": "string" }, + {}, { "description": "the project name of the instance group", "name": "project", @@ -18095,11 +19370,6 @@ "name": "domainid", "type": "string" }, - { - "description": "the name of the instance group", - "name": "name", - "type": "string" - }, { "description": "path of the Domain the instance group belongs to", "name": "domainpath", @@ -18111,21 +19381,24 @@ "type": "string" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, - {}, - {}, - { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the name of the instance group", + "name": "name", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -18135,11 +19408,28 @@ "name": "createStaticRoute", "params": [ { - "description": "the gateway id we are creating static route for", + "description": "the vpc id for which the static route is created. This is required for nexthop parameter", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "the next hop of static route. Mutually exclusive with the gatewayid parameter", + "length": 255, + "name": "nexthop", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "the gateway id we are creating static route for. Mutually exclusive with the nexthop parameter", "length": 255, "name": "gatewayid", "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": true, + "required": false, "type": "uuid" }, { @@ -18152,28 +19442,73 @@ ], "related": "listStaticRoutes", "response": [ + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the static route", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "VPC gateway the route is created for", + "name": "vpcgatewayid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of static route", + "name": "id", + "type": "string" + }, + { + "description": "Next hop of the static route", + "name": "nexthop", + "type": "string" + }, + { + "description": "the project name of the static route", + "name": "project", + "type": "string" + }, + { + "description": "the domain path associated with the static route", + "name": "domainpath", + "type": "string" + }, { "description": "the list of resource tags associated with static route", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -18182,8 +19517,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -18192,74 +19527,44 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, - { - "description": "the state of the static route", - "name": "state", - "type": "string" - }, - { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, + {}, { "description": "the domain associated with the static route", "name": "domain", "type": "string" }, - { - "description": "the domain path associated with the static route", - "name": "domainpath", - "type": "string" - }, - {}, - { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the static route", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the domain associated with the static route", "name": "domainid", "type": "string" }, - { - "description": "VPC gateway the route is created for", - "name": "gatewayid", - "type": "string" - }, { "description": "VPC the static route belongs to", "name": "vpcid", @@ -18267,18 +19572,13 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of static route", - "name": "id", + "description": "the state of the static route", + "name": "state", "type": "string" }, { - "description": "the project name of the static route", - "name": "project", + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", "type": "string" } ] @@ -18298,27 +19598,27 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -18353,19 +19653,9 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", + "type": "string" }, { "description": "the total volume being used by this domain", @@ -18373,91 +19663,106 @@ "type": "long" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the name of the domain", + "name": "name", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, - {}, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" }, {}, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the state of the domain", + "name": "state", + "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" }, { "description": "the total number of snapshots which can be stored by this domain", @@ -18465,39 +19770,44 @@ "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the total number of cpu cores owned by domain", @@ -18505,58 +19815,108 @@ "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, { "description": "the level of the domain", "name": "level", "type": "integer" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { @@ -18565,39 +19925,39 @@ "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { "description": "the total number of public ip addresses allocated for this domain", @@ -18605,14 +19965,29 @@ "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" + }, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" } ] }, @@ -18633,40 +20008,55 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the account owning the vm group", + "name": "account", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, - {}, { "description": "the lb provider of the guest network the lb rule belongs to", "name": "lbprovider", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + { + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, { "description": "the project id of the vm group", @@ -18674,9 +20064,9 @@ "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { "description": "is group for display to the regular user", @@ -18684,29 +20074,29 @@ "type": "boolean" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -18714,69 +20104,54 @@ "type": "integer" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", "type": "int" }, {}, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" - }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private port", + "name": "privateport", + "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" } ] @@ -18786,14 +20161,6 @@ "isasync": false, "name": "createSnapshotPolicy", "params": [ - { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", "length": 255, @@ -18802,21 +20169,36 @@ "type": "string" }, { - "description": "the ID of the disk volume", + "description": "maximum number of snapshots to retain", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "maxsnaps", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "intervaltype", + "required": true, + "type": "string" + }, + { + "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.", + "length": 255, + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, + "since": "4.21.0", "type": "list" }, + { + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", + "length": 255, + "name": "usestoragereplication", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, { "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, @@ -18825,57 +20207,67 @@ "type": "string" }, { - "description": "Map of tags (key/value pairs)", + "description": "an optional field, whether to the display the policy to the end user or not", "length": 255, - "name": "tags", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "the ID of the disk volume", "length": 255, - "name": "intervaltype", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "maximum number of snapshots to retain", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "maxsnaps", - "required": true, - "type": "integer" + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", + "length": 255, + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" } ], "related": "updateSnapshotPolicy,listSnapshotPolicies", "response": [ {}, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "time the snapshot is scheduled to be taken.", "name": "schedule", "type": "string" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -18894,68 +20286,73 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, + {}, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" - }, - { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { "description": "the time zone of the snapshot policy", "name": "timezone", "type": "string" }, - {}, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { "description": "true if the entity/resource has annotations", @@ -18985,27 +20382,27 @@ ], "response": [ {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.11" }, @@ -19024,12 +20421,12 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -19040,61 +20437,127 @@ "name": "success", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.19.1" }, { - "description": "List system virtual machines.", + "description": "Adds an API permission to a role", "isasync": false, - "name": "listSystemVms", + "name": "createRolePermission", "params": [ { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "description": "The API name or wildcard rule such as list*", "length": 255, - "name": "systemvmtype", - "required": false, + "name": "rule", + "required": true, "type": "string" }, { - "description": "", + "description": "ID of the role", "length": 255, - "name": "pagesize", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" + }, + { + "description": "The description of the role permission", + "length": 255, + "name": "description", "required": false, + "type": "string" + }, + { + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, + "type": "string" + } + ], + "related": "listRolePermissions", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the state of the system VM", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the api name or wildcard rule", + "name": "rule", + "type": "string" + }, + {}, + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" + }, + { + "description": "the ID of the role permission", + "name": "id", + "type": "string" + }, + { + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "type": "string" + }, + { + "description": "the description of the role permission", + "name": "description", + "type": "string" + }, + { + "description": "the name of the role to which the role permission belongs", + "name": "rolename", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "List system virtual machines.", + "isasync": false, + "name": "listSystemVms", + "params": [ + { + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "state", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "CPU arch of the system VM", + "description": "the state of the system VM", "length": 255, - "name": "arch", + "name": "state", "required": false, - "since": "4.20.1", "type": "string" }, { - "description": "the Zone ID of the system VM", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the system VM", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, @@ -19107,28 +20570,29 @@ "type": "uuid" }, { - "description": "", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "page", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "since": "3.0.1", + "type": "uuid" }, { - "description": "the Pod ID of the system VM", + "description": "the Zone ID of the system VM", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "CPU arch of the system VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "arch", "required": false, - "since": "3.0.1", - "type": "uuid" + "since": "4.20.1", + "type": "string" }, { "description": "the host ID of the system VM", @@ -19139,43 +20603,48 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the Pod ID of the system VM", "length": 255, - "name": "keyword", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the system VM", + "length": 255, + "name": "name", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { @@ -19184,90 +20653,64 @@ "type": "date" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, - { - "description": "the name of the system VM", - "name": "name", - "type": "string" - }, - { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, - {}, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, {}, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -19275,39 +20718,14 @@ "name": "publicvlan", "type": "list" }, - { - "description": "the systemvm agent version", - "name": "version", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the system VM", - "name": "state", - "type": "string" - }, - { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -19316,138 +20734,107 @@ "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, + {}, { "description": "the template ID for the system VM", "name": "templateid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { "description": "the private IP address for the system VM", "name": "privateip", "type": "string" - } - ] - }, - { - "description": "Adds an API permission to a role", - "isasync": false, - "name": "createRolePermission", - "params": [ + }, { - "description": "The API name or wildcard rule such as list*", - "length": 255, - "name": "rule", - "required": true, + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, - "type": "string" - } - ], - "related": "listRolePermissions", - "response": [ - { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the ID of the role permission", - "name": "id", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the description of the role permission", - "name": "description", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, - {}, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" } - ], - "since": "4.9.0" + ] }, { "description": "Detaches a disk volume from a virtual machine.", @@ -19455,19 +20842,19 @@ "name": "detachVolume", "params": [ { - "description": "the device ID on the virtual machine where volume is detached from", + "description": "the ID of the virtual machine where the volume is detached from", "length": 255, - "name": "deviceid", + "name": "virtualmachineid", + "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", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the ID of the virtual machine where the volume is detached from", + "description": "the device ID on the virtual machine where volume is detached from", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "deviceid", "required": false, - "type": "uuid" + "type": "long" }, { "description": "the ID of the disk volume", @@ -19481,74 +20868,64 @@ "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { "description": "cluster id of the volume", @@ -19556,19 +20933,19 @@ "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { "description": "name of the disk volume", @@ -19576,145 +20953,210 @@ "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { @@ -19728,8 +21170,8 @@ "type": "integer" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { @@ -19738,170 +21180,115 @@ "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the status of the volume", + "name": "status", "type": "string" }, + {}, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, + {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" } ] @@ -19911,14 +21298,6 @@ "isasync": true, "name": "replaceNetworkACLList", "params": [ - { - "description": "the ID of the network ACL", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, - "type": "uuid" - }, { "description": "the ID of the network", "length": 255, @@ -19927,6 +21306,14 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, + "type": "uuid" + }, { "description": "the ID of the private gateway", "length": 255, @@ -19937,27 +21324,27 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -19967,71 +21354,59 @@ "name": "listTungstenFabricAddressGroup", "params": [ { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "keyword", + "name": "addressgroupuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric address group", + "description": "the ID of zone", "length": 255, - "name": "addressgroupuuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createTungstenFabricAddressGroup", "response": [ - {}, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, { "description": "Tungsten-Fabric address group ip prefix length", "name": "ipprefixlen", "type": "int" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -20043,9 +21418,21 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", + "type": "string" + }, + { + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "type": "string" + }, + {}, + {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, @@ -20066,71 +21453,71 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "description": "the ID of the host", - "name": "hostid", + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - {}, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the operation result description", + "name": "description", "type": "string" }, + {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" } ], "since": "4.9.0" @@ -20141,46 +21528,46 @@ "name": "listLdapUsers", "params": [ { - "description": "linked domain", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", "length": 255, - "name": "listtype", + "name": "userfilter", "required": false, + "since": "4.13", "type": "string" }, { - "description": "List by keyword", + "description": "linked domain", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", + "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", "length": 255, - "name": "userfilter", + "name": "listtype", "required": false, - "since": "4.13", "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -20188,13 +21575,8 @@ "related": "searchLdap,importLdapUsers", "response": [ { - "description": "The user's lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "The user's username", - "name": "username", + "description": "The user's principle", + "name": "principal", "type": "string" }, { @@ -20202,36 +21584,41 @@ "name": "domain", "type": "string" }, - { - "description": "The user's principle", - "name": "principal", - "type": "string" - }, { "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", "name": "conflictingusersource", "type": "string" }, {}, + { + "description": "The user's username", + "name": "username", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The user's email", - "name": "email", + "description": "The user's lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "The user's firstname", "name": "firstname", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The user's email", + "name": "email", "type": "string" } ], @@ -20242,27 +21629,41 @@ "isasync": false, "name": "createVMSchedule", "params": [ + { + "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "Enable VM schedule. Defaults to true", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, { "description": "ID of the VM for which schedule is to be defined", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "uuid" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "Description of the schedule", "length": 255, - "name": "schedule", - "required": true, + "name": "description", + "required": false, "type": "string" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "name": "timezone", + "required": true, + "type": "string" }, { "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", @@ -20272,39 +21673,25 @@ "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", "length": 255, - "name": "timezone", + "name": "schedule", "required": true, "type": "string" }, { - "description": "Enable VM schedule. Defaults to true", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, - { - "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" - }, - { - "description": "Description of the schedule", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "updateVMSchedule", "response": [ { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { @@ -20312,35 +21699,24 @@ "name": "created", "type": "date" }, + { + "description": "Action", + "name": "action", + "type": "action" + }, { "description": "Description of VM schedule", "name": "description", "type": "string" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" - }, - {}, - { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" - }, - { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -20348,21 +21724,32 @@ "name": "startdate", "type": "date" }, - { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + }, { "description": "the ID of VM schedule", "name": "id", "type": "string" }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ], "since": "4.19.0" @@ -20373,64 +21760,71 @@ "name": "listIpForwardingRules", "params": [ { - "description": "Lists rule with the specified ID.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "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.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "account", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { "description": "Lists all rules applied to the specified VM.", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list the rule belonging to this public IP address", @@ -20446,101 +21840,47 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - {}, - {}, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the id of the guest network the port forwarding rule belongs to", "name": "networkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -20548,14 +21888,19 @@ "name": "project", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -20563,53 +21908,95 @@ "name": "resourcetype", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + {}, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, { "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, { "description": "the protocol of the port forwarding rule", "name": "protocol", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { "description": "the VM name for the port forwarding rule", "name": "virtualmachinename", "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" } ] }, @@ -20619,42 +22006,44 @@ "name": "createSnapshot", "params": [ { - "description": "quiesce vm if true", + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", "length": 255, - "name": "quiescevm", + "name": "usestoragereplication", "required": false, "type": "boolean" }, { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "locationtype", + "name": "account", "required": false, "type": "string" }, { - "description": "A comma-separated list of IDs of the 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.", + "description": "The ID of the disk volume", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "list" + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", + "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.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "list" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "A comma-separated list of IDs of the 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.", "length": 255, - "name": "account", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "since": "4.19.0", + "type": "list" }, { "description": "the name of the snapshot", @@ -20664,12 +22053,18 @@ "type": "string" }, { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "description": "asynchronous backup if true", "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy,listSnapshotPolicies", + "name": "asyncbackup", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "length": 255, + "name": "locationtype", + "required": false, + "type": "string" }, { "description": "Map of tags (key/value pairs)", @@ -20679,46 +22074,45 @@ "type": "map" }, { - "description": "asynchronous backup if true", + "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", "length": 255, - "name": "asyncbackup", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "The ID of the disk volume", + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, + "name": "policyid", + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "required": false, "type": "uuid" + }, + { + "description": "quiesce vm if true", + "length": 255, + "name": "quiescevm", + "required": false, + "type": "boolean" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "response": [ - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, + {}, { "description": "name of the availability zone", "name": "zonename", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "state of the disk volume", - "name": "volumestate", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { @@ -20727,70 +22121,73 @@ "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, + { + "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", + "name": "state", + "type": "state" + }, { "description": "display name of the os on volume", "name": "osdisplayname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { "description": "virtual size of backedup snapshot on image store", "name": "virtualsize", "type": "long" }, - {}, { - "description": "id of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" }, - {}, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -20798,71 +22195,66 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -20871,48 +22263,59 @@ "type": "boolean" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, + {}, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "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", - "name": "state", - "type": "state" + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { @@ -20921,8 +22324,13 @@ "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" } ] @@ -20933,20 +22341,13 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "host ID of the storage pools", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the storage pool", "length": 255, @@ -20958,18 +22359,10 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, { "description": "If true, lists the custom stats of the storage pool", "length": 255, @@ -20986,10 +22379,34 @@ "type": "string" }, { - "description": "the storage pool path", + "description": "the name of the storage pool", "length": 255, - "name": "path", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list storage pools belonging to the specific cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, + "type": "uuid" + }, + { + "description": "host ID of the storage pools", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", "type": "string" }, { @@ -21001,78 +22418,113 @@ "type": "uuid" }, { - "description": "the name of the storage pool", + "description": "the storage pool path", "length": 255, - "name": "name", + "name": "path", "required": false, "type": "string" }, { - "description": "the scope of the storage pool", + "description": "the IP address for the storage pool", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the scope of the storage pool", "length": 255, - "name": "keyword", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "the IP address for the storage pool", + "description": "List by keyword", "length": 255, - "name": "ipaddress", + "name": "keyword", "required": false, "type": "string" } ], "related": "", "response": [ + { + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", + "type": "string" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", + "description": "disk size in GiB", + "name": "disksizetotalgb", + "type": "string" + }, + { + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", "type": "boolean" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { @@ -21081,9 +22533,14 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" }, { "description": "Whether the informed tag is a JS interpretable rule or not.", @@ -21091,19 +22548,19 @@ "type": "boolean" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" }, { "description": "the state of the storage pool", @@ -21116,54 +22573,44 @@ "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, + {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the storage pool type", + "name": "type", + "type": "string" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { @@ -21172,49 +22619,28 @@ "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, - { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, - {}, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", + "description": "disk size used in GiB", + "name": "disksizeusedgb", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { @@ -21223,28 +22649,28 @@ "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" } ], @@ -21255,13 +22681,6 @@ "isasync": false, "name": "createSSHKeyPair", "params": [ - { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional project for the ssh key", "length": 255, @@ -21271,12 +22690,11 @@ "type": "uuid" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Name of the keypair", @@ -21284,35 +22702,47 @@ "name": "name", "required": true, "type": "string" + }, + { + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" }, - {}, { - "description": "Name of the keypair", - "name": "name", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "Private key", - "name": "privatekey", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -21320,34 +22750,30 @@ "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "Name of the keypair", + "name": "name", "type": "string" }, - {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, + {}, + {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" } ] @@ -21367,17 +22793,6 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -21388,6 +22803,17 @@ "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ], "since": "4.14.0" @@ -21398,19 +22824,19 @@ "name": "listTungstenFabricServiceGroup", "params": [ { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric service group", + "description": "the ID of zone", "length": 255, - "name": "servicegroupuuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -21420,9 +22846,9 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric service group", "length": 255, - "name": "keyword", + "name": "servicegroupuuid", "required": false, "type": "string" }, @@ -21437,21 +22863,10 @@ "related": "createTungstenFabricServiceGroup", "response": [ { - "description": "Tungsten-Fabric service group name", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -21463,24 +22878,35 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" }, { "description": "Tungsten-Fabric service group end port", "name": "endport", "type": "int" }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" } ] @@ -21491,48 +22917,56 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "start port for this egress rule", + "description": "user to security group mapping", "length": 255, - "name": "startport", + "name": "usersecuritygrouplist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "TCP is default. UDP is the other supported protocol", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "protocol", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "type of the icmp message being sent", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "icmptype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "error code for this icmp message", "length": 255, - "name": "account", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, "type": "uuid" }, { - "description": "end port for this egress rule", + "description": "type of the icmp message being sent", "length": 255, - "name": "endport", + "name": "icmptype", "required": false, "type": "integer" }, + { + "description": "TCP is default. UDP is the other supported protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, { "description": "an optional project of the security group", "length": 255, @@ -21542,64 +22976,50 @@ "type": "uuid" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "start port for this egress rule", "length": 255, - "name": "securitygroupname", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "error code for this icmp message", + "description": "end port for this egress rule", "length": 255, - "name": "icmpcode", + "name": "endport", "required": false, "type": "integer" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "user to security group mapping", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "usersecuritygrouplist", + "name": "account", "required": false, - "type": "map" + "type": "string" } ], "related": "authorizeSecurityGroupIngress", "response": [ - {}, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -21607,9 +23027,14 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", @@ -21621,18 +23046,18 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -21641,8 +23066,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -21651,31 +23081,32 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "set" }, + {}, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -21684,20 +23115,15 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {} ], "since": "3.0.0" @@ -21708,40 +23134,42 @@ "name": "listStoragePools", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the storage pool path", "length": 255, - "name": "pagesize", + "name": "path", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If true, lists the custom stats of the storage pool", + "description": "the scope of the storage pool", "length": 255, - "name": "storagecustomstats", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "string" }, { - "description": "the storage pool path", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "path", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the status of the storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "status", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the IP address for the storage pool", @@ -21751,108 +23179,134 @@ "type": "string" }, { - "description": "the ID of the storage pool", + "description": "", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the name of the storage pool", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "the name of the storage access group", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "storageaccessgroup", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "the ID of the storage pool", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "host ID of the storage pools", + "description": "list storage pools belonging to the specific cluster", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the scope of the storage pool", + "description": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "storagecustomstats", "required": false, - "type": "string" + "since": "4.18.1", + "type": "boolean" }, { - "description": "the Zone ID for the storage pool", + "description": "host ID of the storage pools", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "the name of the storage pool", + "description": "the status of the storage pool", "length": 255, - "name": "name", + "name": "status", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the storage pool type", - "name": "type", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, { @@ -21861,18 +23315,18 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { @@ -21880,16 +23334,7 @@ "name": "capacityiops", "type": "long" }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" - }, + {}, { "description": "the name of the storage pool", "name": "name", @@ -21900,88 +23345,87 @@ "name": "overprovisionfactor", "type": "string" }, + {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "total IOPS currently in use", + "name": "usediops", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, { "description": "the Pod name of the storage pool", "name": "podname", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" - }, - {}, - {} + } ] }, { @@ -21990,36 +23434,35 @@ "name": "updateHypervisorCapabilities", "params": [ { - "description": "the maximum number of the hypervisor hosts per cluster ", + "description": "set true to enable security group for this hypervisor.", "length": 255, - "name": "maxhostspercluster", + "name": "securitygroupenabled", "required": false, - "since": "4.16.0", - "type": "integer" + "type": "boolean" }, { - "description": "the hypervisor version for which the hypervisor capabilities are to be updated", + "description": "the maximum number of the hypervisor hosts per cluster ", "length": 255, - "name": "hypervisorversion", + "name": "maxhostspercluster", "required": false, - "since": "4.19.1", - "type": "string" + "since": "4.16.0", + "type": "integer" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "set true to enable storage motion support for this hypervisor", "length": 255, - "name": "vmsnapshotenabled", + "name": "storagemotionenabled", "required": false, "since": "4.16.0", "type": "boolean" }, { - "description": "the hypervisor for which the hypervisor capabilities are to be updated", + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", "length": 255, - "name": "hypervisor", + "name": "maxdatavolumeslimit", "required": false, - "since": "4.19.1", - "type": "string" + "since": "4.16.0", + "type": "integer" }, { "description": "ID of the hypervisor capability", @@ -22030,44 +23473,45 @@ "type": "uuid" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "set true to enable VM snapshots for this hypervisor", "length": 255, - "name": "securitygroupenabled", + "name": "vmsnapshotenabled", "required": false, + "since": "4.16.0", "type": "boolean" }, { - "description": "set true to enable storage motion support for this hypervisor", + "description": "the hypervisor for which the hypervisor capabilities are to be updated", "length": 255, - "name": "storagemotionenabled", + "name": "hypervisor", "required": false, - "since": "4.16.0", - "type": "boolean" + "since": "4.19.1", + "type": "string" }, { - "description": "the max number of Guest VMs per host for this hypervisor.", + "description": "the hypervisor version for which the hypervisor capabilities are to be updated", "length": 255, - "name": "maxguestslimit", + "name": "hypervisorversion", "required": false, - "type": "long" + "since": "4.19.1", + "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "maxdatavolumeslimit", + "name": "maxguestslimit", "required": false, - "since": "4.16.0", - "type": "integer" + "type": "long" } ], "related": "listHypervisorCapabilities", "response": [ - {}, { - "description": "the hypervisor type", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the maximum number of Hosts per cluster for this hypervisor", "name": "maxhostspercluster", @@ -22078,32 +23522,37 @@ "name": "storagemotionenabled", "type": "boolean" }, - {}, + { + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + }, + { + "description": "the hypervisor type", + "name": "hypervisor", + "type": "string" + }, { "description": "the ID of the hypervisor capabilities row", "name": "id", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, + { + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" + }, { "description": "the maximum number of guest vms recommended for this hypervisor", "name": "maxguestslimit", "type": "long" }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, { "description": "true if security group is supported", "name": "securitygroupenabled", @@ -22113,11 +23562,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" } ], "since": "3.0.0" @@ -22128,11 +23572,12 @@ "name": "findHostsForMigration", "params": [ { - "description": "List by keyword", + "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "virtualmachineid", + "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", + "required": true, + "type": "uuid" }, { "description": "", @@ -22142,12 +23587,11 @@ "type": "integer" }, { - "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", + "description": "List by keyword", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -22160,24 +23604,103 @@ "related": "", "response": [ { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { "description": "the outgoing network traffic on the host", @@ -22185,28 +23708,43 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the name of the host", + "name": "name", "type": "string" }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, { "description": "the date and time the host was last pinged", "name": "lastpinged", "type": "date" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the ID of the host", + "name": "id", "type": "string" }, { @@ -22215,345 +23753,302 @@ "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, { "description": "true if the host has capability to support UEFI boot", "name": "ueficapability", "type": "boolean" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, + {}, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, {}, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" } ] }, @@ -22573,46 +24068,30 @@ ], "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" - }, - {}, { "description": "device state", "name": "vsmdevicestate", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", "type": "int" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" - }, - { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { @@ -22621,13 +24100,18 @@ "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", "type": "int" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" + }, + { + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { @@ -22640,6 +24124,17 @@ "name": "vsmmgmtvlanid", "type": "string" }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", + "type": "string" + }, + {}, { "description": "device id of the Cisco N1KV VSM device", "name": "vsmdeviceid", @@ -22663,6 +24158,12 @@ ], "related": "", "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -22673,12 +24174,6 @@ "description": "is domain admin allowed to create offerings with tags", "name": "isallowed", "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -22691,16 +24186,17 @@ "description": "Virtual Machine ID", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "uuid" }, { - "description": "IP Address for the new network", + "description": "Network ID", "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { "description": "Mac Address for the new network", @@ -22710,248 +24206,510 @@ "type": "string" }, { - "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", + "description": "IP Address for the new network", "length": 255, - "name": "dhcpoptions", + "name": "ipaddress", "required": false, - "type": "map" + "type": "string" }, { - "description": "Network ID", + "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "name": "dhcpoptions", + "required": false, + "type": "map" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,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,importUnmanagedInstance,importVm", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,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", "response": [ + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, { "description": "Guest vm Boot Mode", "name": "bootmode", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the type of the affinity group", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { @@ -22960,243 +24718,233 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, + {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, - {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, + {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, - {}, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { "description": "List of read-only Vm details as comma separated string.", @@ -23204,101 +24952,135 @@ "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -23317,537 +25099,284 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project name of the group", + "name": "project", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, { "description": "ssh key-pairs", "name": "keypairs", "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - } - ], - "type": "set" - } - ] - }, - { - "description": "Returns SAML2 CloudStack Service Provider MetaData", - "isasync": false, - "name": "getSPMetadata", - "params": [], - "related": "", - "response": [ - { - "description": "The Metadata XML", - "name": "metadata", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -23857,24 +25386,24 @@ "name": "listStaticRoutes", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list static routes by state", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "state", + "name": "account", "required": false, "type": "string" }, { - "description": "list static routes by gateway id", + "description": "list static routes by vpc id", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, @@ -23886,12 +25415,11 @@ "type": "string" }, { - "description": "list static route by id", + "description": "", "length": 255, - "name": "id", - "related": "listStaticRoutes", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -23902,102 +25430,87 @@ "type": "uuid" }, { - "description": "", + "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.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list static routes by gateway id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list static route by id", "length": 255, - "name": "account", + "name": "id", + "related": "listStaticRoutes", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list static routes by vpc id", + "description": "list static routes by state", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" } ], "related": "", "response": [ - { - "description": "the domain path associated with the static route", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the static route", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "the ID of static route", - "name": "id", - "type": "string" - }, - { - "description": "the account associated with the static route", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -24006,8 +25519,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -24015,48 +25528,48 @@ "name": "domain", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "Next hop of the static route", + "name": "nexthop", + "type": "string" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the state of the static route", - "name": "state", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { @@ -24065,13 +25578,39 @@ "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "VPC gateway the route is created for", + "name": "vpcgatewayid", + "type": "string" + }, + { + "description": "the domain path associated with the static route", + "name": "domainpath", + "type": "string" + }, + { + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the ID of static route", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the domain associated with the static route", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, { @@ -24080,9 +25619,9 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -24092,57 +25631,35 @@ "name": "listPublicIpAddresses", "params": [ { - "description": "lists all public IP addresses by source network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.13.0", - "type": "uuid" - }, - { - "description": "true if range is dedicated for system VMs", - "length": 255, - "name": "forsystemvms", - "required": false, - "since": "4.20.0", - "type": "boolean" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list only static NAT IP addresses", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isstaticnat", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "lists the specified IP address", "length": 255, - "name": "account", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "true if range is dedicated for external network provider", "length": 255, - "name": "fordisplay", + "name": "forprovider", "required": false, - "since": "4.4", + "since": "4.21.0", "type": "boolean" }, { - "description": "lists all public IP addresses by state", + "description": "lists all public IP addresses by physical network ID", "length": 255, - "name": "state", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "lists all public IP addresses by zone ID", @@ -24153,20 +25670,18 @@ "type": "uuid" }, { - "description": "List IPs belonging to the VPC", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only static NAT IP addresses", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isstaticnat", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "lists IP address by ID", @@ -24177,52 +25692,53 @@ "type": "uuid" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "list only IPs used for load balancing", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "forloadbalancing", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "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.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list only IPs used for load balancing", + "description": "list only source NAT IP addresses", "length": 255, - "name": "forloadbalancing", + "name": "issourcenat", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "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.", + "description": "lists all public IP addresses by source network ID", "length": 255, - "name": "listall", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "since": "4.13.0", + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "isrecursive", + "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, @@ -24233,6 +25749,13 @@ "required": false, "type": "boolean" }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -24242,96 +25765,80 @@ "type": "uuid" }, { - "description": "lists all public IP addresses by physical network ID", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list only source NAT IP addresses", + "description": "the virtual network for the IP address", "length": 255, - "name": "issourcenat", + "name": "forvirtualnetwork", "required": false, "type": "boolean" }, { - "description": "lists the specified IP address", + "description": "", "length": 255, - "name": "ipaddress", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the virtual network for the IP address", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "forvirtualnetwork", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "lists all public IP addresses by VLAN ID", + "description": "lists all public IP addresses associated to the network specified", "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" - } - ], - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "response": [ - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" }, { - "description": "VPC id the ip belongs to", + "description": "List IPs belonging to the VPC", + "length": 255, "name": "vpcid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if range is dedicated for system VMs", + "length": 255, + "name": "forsystemvms", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "description": "lists all public IP addresses by state", + "length": 255, "name": "state", + "required": false, "type": "string" - }, - { - "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", - "name": "purpose", - "type": "string" - }, + } + ], + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { "description": "the VLAN associated with the IP address", @@ -24339,44 +25846,28 @@ "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", "type": "boolean" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, - {}, { - "description": "public IP address", - "name": "ipaddress", + "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", + "name": "purpose", "type": "string" }, { @@ -24384,71 +25875,66 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { @@ -24457,53 +25943,79 @@ "type": "boolean" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, + {}, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { @@ -24511,71 +26023,111 @@ "name": "associatednetworkid", "type": "string" }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, { "description": "date the public IP address was acquired", "name": "allocated", "type": "date" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "true if range is dedicated for external network providers", + "name": "forprovider", "type": "boolean" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, - {}, { - "description": "public IP address id", - "name": "id", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" - } - ] - }, - { - "description": "Lists OpenDyalight controllers", - "isasync": false, - "name": "listOpenDaylightControllers", - "params": [ + }, { - "description": "the ID of a OpenDaylight Controller", - "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", - "required": false, - "type": "uuid" + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + {} + ] + }, + { + "description": "Lists OpenDyalight controllers", + "isasync": false, + "name": "listOpenDaylightControllers", + "params": [ + { + "description": "the Physical Network ID", + "length": 255, "name": "physicalnetworkid", "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" + }, + { + "description": "the ID of a OpenDaylight Controller", + "length": 255, + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "required": false, + "type": "uuid" } ], "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "device id of the controller", - "name": "id", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { @@ -24583,28 +26135,28 @@ "name": "jobid", "type": "string" }, - {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the url of the controller api", "name": "url", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, + {}, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "device id of the controller", + "name": "id", "type": "string" }, - { - "description": "the username to authenticate to the controller", - "name": "username", - "type": "string" - } + {} ] }, { @@ -24613,20 +26165,12 @@ "name": "addBigSwitchBcfDevice", "params": [ { - "description": "Password of the BigSwitch BCF Controller.", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", "length": 255, - "name": "password", + "name": "hostname", "required": true, "type": "string" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, { "description": "NAT support of the BigSwitch BCF Controller.", "length": 255, @@ -24635,16 +26179,24 @@ "type": "boolean" }, { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "description": "Username of the BigSwitch BCF Controller.", "length": 255, - "name": "hostname", + "name": "username", "required": true, "type": "string" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "Password of the BigSwitch BCF Controller.", + "length": 255, + "name": "password", "required": true, "type": "string" } @@ -24652,13 +26204,8 @@ "related": "listBigSwitchBcfDevices", "response": [ { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { @@ -24667,13 +26214,23 @@ "type": "string" }, { - "description": "the controller username", - "name": "username", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "NAT support", + "name": "nat", + "type": "boolean" + }, + { + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { @@ -24681,27 +26238,22 @@ "name": "bigswitchdevicename", "type": "string" }, - { - "description": "NAT support", - "name": "nat", - "type": "boolean" - }, - {}, - {}, { "description": "the controller password", "name": "password", "type": "string" }, + {}, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the controller username", + "name": "username", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.6.0" @@ -24723,147 +26275,56 @@ "description": "Virtual Machine ID", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,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,importUnmanagedInstance,importVm", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,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", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "response": [ { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - {}, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -24871,51 +26332,138 @@ "name": "securitygroup", "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -24924,8 +26472,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -24934,8 +26482,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -24944,36 +26497,51 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -24984,53 +26552,23 @@ ], "type": "set" }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -25039,33 +26577,13 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -25078,18 +26596,23 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -25098,8 +26621,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -25108,23 +26631,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -25134,83 +26652,26 @@ } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" @@ -25219,28 +26680,34 @@ "type": "set" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, + {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -25249,221 +26716,208 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "the total number of network traffic bytes sent", "name": "sentbytes", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -25472,34 +26926,75 @@ "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, { "description": "the memory used by the VM in KiB", "name": "memorykbs", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + {}, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { "description": "the ID of the service offering of the virtual machine", @@ -25507,270 +27002,259 @@ "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, { "description": "IP addresses associated with NIC found for unmanaged VM", "name": "ipaddresses", "type": "list" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -25779,52 +27263,180 @@ "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { "description": "ID of the VLAN/VNI if available", "name": "vlanid", "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + {}, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" } ] }, @@ -25853,47 +27465,47 @@ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, - {}, { "description": "unique ID of the drs plan for cluster", "name": "id", "type": "string" }, - {}, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, - { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - }, { "description": "List of migrations", "name": "migrations", "type": "list" }, - { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.19.0" }, @@ -25912,17 +27524,12 @@ } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -25933,6 +27540,11 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -25948,6 +27560,13 @@ "required": true, "type": "string" }, + { + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "long" + }, { "description": "the ID of the host", "length": 255, @@ -25955,83 +27574,76 @@ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" - }, - { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", - "length": 255, - "name": "timeout", - "required": false, - "type": "long" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the ID of the host", - "name": "hostid", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, - {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, + {}, { "description": "the operation result", "name": "status", "type": "boolean" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" + }, + {}, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" } ], "since": "4.9.0" @@ -26041,6 +27653,22 @@ "isasync": true, "name": "createSharedFileSystem", "params": [ + { + "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "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.", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + }, { "description": "the description for the shared filesystem.", "length": 255, @@ -26048,6 +27676,21 @@ "required": false, "type": "string" }, + { + "description": "network to attach the shared filesystem to", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" + }, { "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.", "length": 255, @@ -26057,18 +27700,18 @@ "type": "uuid" }, { - "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", + "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", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", + "description": "the name of the shared filesystem.", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -26078,6 +27721,13 @@ "required": false, "type": "long" }, + { + "description": "the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, { "description": "the zone id.", "length": 255, @@ -26087,70 +27737,88 @@ "type": "uuid" }, { - "description": "max iops", + "description": "min iops", "length": 255, - "name": "maxiops", + "name": "miniops", "required": false, "type": "long" }, { - "description": "the name of the shared filesystem.", + "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", "length": 255, - "name": "name", + "name": "filesystem", "required": true, "type": "string" }, { - "description": "the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.", + "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", "length": 255, - "name": "provider", + "name": "account", "required": false, "type": "string" + } + ], + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ + {}, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "min iops", - "length": 255, - "name": "miniops", - "required": false, + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", - "length": 255, - "name": "filesystem", - "required": true, + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "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.", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" }, { - "description": "network to attach the shared filesystem to", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" }, { - "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", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - } - ], - "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "response": [ + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { @@ -26158,20 +27826,45 @@ "name": "virtualsize", "type": "long" }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, {}, { - "description": "name of the shared filesystem", - "name": "name", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { @@ -26179,8 +27872,8 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -26188,14 +27881,19 @@ "name": "value", "type": "string" }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -26204,155 +27902,85 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" } ], "type": "set" }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -26361,24 +27989,19 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { "description": "the gateway of the nic", @@ -26386,18 +28009,8 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -26406,19 +28019,19 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { "description": "the name of the corresponding network", @@ -26426,66 +28039,81 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "list" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the shared filesystem", + "name": "name", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { @@ -26494,53 +28122,33 @@ "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, { "description": "the shared filesystem's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { @@ -26549,39 +28157,43 @@ "type": "long" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, - {}, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" } ], @@ -26602,27 +28214,27 @@ } ], "response": [ - {}, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -26632,21 +28244,14 @@ "name": "updateImageStore", "params": [ { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "description": "The new name for the Image Store.", "length": 255, - "name": "readonly", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" - }, - { - "description": "Image Store UUID", + "description": "Image Store UUID", "length": 255, "name": "id", "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", @@ -26654,35 +28259,36 @@ "type": "uuid" }, { - "description": "The new name for the Image Store.", + "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", "length": 255, - "name": "name", + "name": "capacitybytes", "required": false, - "type": "string" + "type": "long" + }, + { + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "length": 255, + "name": "readonly", + "required": false, + "type": "boolean" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - {}, { "description": "the url of the image store", "name": "url", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the host's currently used disk size", @@ -26690,46 +28296,52 @@ "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the ID of the image store", - "name": "id", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, + {}, + {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the protocol of the image store", "name": "protocol", "type": "string" }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, { "description": "the name of the image store", "name": "name", @@ -26751,47 +28363,127 @@ "since": "4.4", "type": "map" }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", - "required": true, - "type": "uuid" - }, { "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", "length": 255, "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": false, "type": "list" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], "response": [ + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + } + ] + }, + { + "description": "Configure the storage access groups on zone/pod/cluster/host and storage, accordingly connections to the storage pools", + "isasync": true, + "name": "configureStorageAccess", + "params": [ + { + "description": "UUID of the host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "comma separated list of storage access groups for connecting the storage pools and the hosts", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" + }, + { + "description": "UUID of the Storage Pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of the pod", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, + { + "description": "UUID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} - ] + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.21.0" }, { "description": "Lists all pending asynchronous jobs for the account.", @@ -26799,18 +28491,19 @@ "name": "listAsyncJobs", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "List by keyword", @@ -26820,47 +28513,46 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "The id of the management server", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "account", "required": false, - "since": "4.19", - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "description": "The id of the management server", "length": 255, - "name": "startdate", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "date" + "since": "4.19", + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -26868,95 +28560,95 @@ "related": "queryAsyncJobResult", "response": [ { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" - }, - { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" - }, - { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", + "description": "the result code for the job", + "name": "jobresultcode", "type": "integer" }, - { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" - }, { "description": " the completed date of the job", "name": "completed", "type": "date" }, + {}, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the async command executed", - "name": "cmd", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the account that executed the async command", + "name": "account", + "type": "string" + }, + { + "description": "the domain that executed the async command", + "name": "domainpath", + "type": "string" }, { "description": " the created date of the job", "name": "created", "type": "date" }, - {}, - { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "the async command executed", + "name": "cmd", "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": "the user that executed the async command", + "name": "userid", + "type": "string" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", "type": "string" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" + }, + { + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" + }, + {}, + { + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id that executed the async command", + "name": "domainid", + "type": "string" + }, + { + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" } ] @@ -26967,16 +28659,17 @@ "name": "archiveAlerts", "params": [ { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the IDs of the alerts", "length": 255, - "name": "enddate", + "name": "ids", + "related": "listAlerts,listAlertTypes", "required": false, - "type": "date" + "type": "list" }, { - "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" }, @@ -26988,15 +28681,21 @@ "type": "string" }, { - "description": "the IDs of the alerts", + "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "ids", - "related": "listAlerts,listAlertTypes", + "name": "startdate", "required": false, - "type": "list" + "type": "date" } ], "response": [ + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -27007,18 +28706,11 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + } ] }, { @@ -27041,23 +28733,23 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -27073,16 +28765,9 @@ "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "The description of the heuristic rule.", "length": 255, - "name": "type", - "required": true, - "type": "string" - }, - { - "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", - "length": 65535, - "name": "heuristicrule", + "name": "description", "required": true, "type": "string" }, @@ -27095,23 +28780,31 @@ "type": "uuid" }, { - "description": "The description of the heuristic rule.", + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", + "required": true, + "type": "string" + }, + { + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "description", + "name": "type", "required": true, "type": "string" } ], "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", "response": [ + {}, { "description": "When the heuristic was removed.", "name": "removed", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, { @@ -27125,37 +28818,36 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" }, { - "description": "Name of the heuristic.", - "name": "name", - "type": "string" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "Description of the heuristic.", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - }, - {} + "description": "Description of the heuristic.", + "name": "description", + "type": "string" + } ], "since": "4.19.0" }, @@ -27165,49 +28857,43 @@ "name": "addBrocadeVcsDevice", "params": [ { - "description": "the Physical Network ID", + "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Hostname of ip address of the Brocade VCS Switch.", + "description": "the Physical Network ID", "length": 255, - "name": "hostname", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Credentials to access the Brocade VCS Switch API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "Hostname of ip address of the Brocade VCS Switch.", "length": 255, - "name": "username", + "name": "hostname", "required": true, "type": "string" } ], "related": "listBrocadeVcsDevices", "response": [ - {}, {}, { "description": "name of the provider", "name": "provider", "type": "string" }, - { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "device name", "name": "brocadedevicename", @@ -27219,8 +28905,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -27228,6 +28914,12 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "device id of the Brocade Vcs", "name": "vcsdeviceid", @@ -27247,44 +28939,44 @@ "required": true, "type": "list" }, - { - "description": "Delete tag by resource type", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - }, { "description": "Delete tags matching key/value pairs", "length": 255, "name": "tags", "required": false, "type": "map" + }, + { + "description": "Delete tag by resource type", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ], "since": "4.0.0" }, @@ -27311,38 +29003,100 @@ ], "related": "listTungstenFabricTagType", "response": [ + { + "description": "Tungsten-Fabric tag type name", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" + } + ] + }, + { + "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", + "isasync": true, + "name": "restartNetwork", + "params": [ + { + "description": "If cleanup old network elements", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "The ID of the network to restart.", + "length": 255, + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "length": 255, + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, + { + "description": "Turn the network into a network with redundant routers.", + "length": 255, + "name": "makeredundant", + "required": false, + "since": "4.11.1", + "type": "boolean" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {} ] }, { @@ -27351,60 +29105,49 @@ "name": "login", "params": [ { - "description": "Username", + "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "Username", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", "length": 255, - "name": "domainId", + "name": "domain", "required": false, - "type": "long" + "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", "length": 255, - "name": "domain", + "name": "domainId", "required": false, - "type": "string" + "type": "long" } ], - "related": "samlSso,oauthlogin", + "related": "oauthlogin", "response": [ { - "description": "Is two factor authentication verified", - "name": "is2faverified", - "type": "string" - }, - { - "description": "last name of the user", - "name": "lastname", - "type": "string" - }, - {}, - { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "Is user registered", + "name": "registered", "type": "string" }, { @@ -27413,13 +29156,8 @@ "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", - "type": "string" - }, - { - "description": "Username", - "name": "username", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { @@ -27432,25 +29170,15 @@ "name": "is2faenabled", "type": "string" }, - { - "description": "User ID", - "name": "userid", - "type": "string" - }, - { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", - "type": "string" - }, { "description": "Two factor authentication provider", "name": "providerfor2fa", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "User ID", + "name": "userid", + "type": "string" }, { "description": "the time period before the session has expired", @@ -27458,83 +29186,52 @@ "type": "integer" }, { - "description": "Is user registered", - "name": "registered", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" - } - ] - }, - { - "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", - "isasync": true, - "name": "restartNetwork", - "params": [ - { - "description": "The ID of the network to restart.", - "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" }, { - "description": "Turn the network into a network with redundant routers.", - "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", - "type": "boolean" + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" }, { - "description": "If cleanup old network elements", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", - "length": 255, - "name": "livepatch", - "required": false, - "since": "4.17.0", - "type": "boolean" - } - ], - "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Management Server ID that the user logged to", + "name": "managementserverid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "first name of the user", + "name": "firstname", + "type": "string" + } ] }, { @@ -27549,6 +29246,13 @@ "required": false, "type": "string" }, + { + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -27557,11 +29261,11 @@ "type": "integer" }, { - "description": "the hypervisor for which to restrict the search", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "ID of the hypervisor capability", @@ -27570,74 +29274,67 @@ "related": "listHypervisorCapabilities", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "the ID of the hypervisor capabilities row", - "name": "id", + "description": "the hypervisor type", + "name": "hypervisor", "type": "string" }, { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "true if VM snapshots are enabled for this hypervisor", "name": "vmsnapshotenabled", "type": "boolean" }, + { + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" + }, { "description": "the hypervisor version", "name": "hypervisorversion", "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" }, - {}, { "description": "true if security group is supported", "name": "securitygroupenabled", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, - { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -27647,18 +29344,18 @@ "name": "deleteProjectRole", "params": [ { - "description": "ID of the project role to be deleted", + "description": "ID of the project from where the role is to be deleted", "length": 255, - "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" }, { - "description": "ID of the project from where the role is to be deleted", + "description": "ID of the project role to be deleted", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": true, "type": "uuid" } @@ -27670,22 +29367,22 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {}, + {} ], "since": "4.15.0" }, @@ -27704,11 +29401,7 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, {}, { "description": "variable", @@ -27720,12 +29413,16 @@ "name": "description", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.20" }, @@ -27742,13 +29439,6 @@ "required": true, "type": "uuid" }, - { - "description": "Start of the period of the Quota balance. 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.", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, { "description": "End of the period of the Quota balance.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.", "length": 255, @@ -27764,6 +29454,13 @@ "required": false, "type": "uuid" }, + { + "description": "Start of the period of the Quota balance. 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.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, { "description": "Account Id for which statement needs to be generated", "length": 255, @@ -27774,6 +29471,21 @@ ], "related": "quotaStatement", "response": [ + { + "description": "usage type", + "name": "type", + "type": "int" + }, + { + "description": "account name", + "name": "account", + "type": "string" + }, + { + "description": "domain id", + "name": "domain", + "type": "long" + }, { "description": "usage type name", "name": "name", @@ -27784,42 +29496,27 @@ "name": "quota", "type": "bigdecimal" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "account id", "name": "accountid", "type": "long" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "usage unit", "name": "unit", "type": "string" }, + {}, { - "description": "account name", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "domain id", - "name": "domain", - "type": "long" - }, - { - "description": "usage type", - "name": "type", - "type": "int" } ], "since": "4.7.0" @@ -27830,38 +29527,38 @@ "name": "getSolidFireAccountId", "params": [ { - "description": "CloudStack Account UUID", + "description": "Storage Pool UUID", "length": 255, - "name": "accountid", + "name": "storageid", "required": true, "type": "string" }, { - "description": "Storage Pool UUID", + "description": "CloudStack Account UUID", "length": 255, - "name": "storageid", + "name": "accountid", "required": true, "type": "string" } ], "related": "", "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "SolidFire Account ID", + "name": "solidFireAccountId", + "type": "long" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -27882,21 +29579,20 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the role permission", + "name": "id", + "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the name of the role to which the role permission belongs", "name": "rolename", @@ -27907,19 +29603,20 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "description": "the ID of the role permission", - "name": "id", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the description of the role permission", + "name": "description", "type": "string" }, {} @@ -27932,45 +29629,55 @@ "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "project who will own the guest VLAN range", + "description": "the dedicated guest vlan range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "guestvlanrange", + "required": false, + "type": "string" + }, + { + "description": "zone of the guest VLAN range", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "account", + "name": "id", + "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the dedicated guest vlan range", + "description": "project who will own the guest VLAN range", "length": 255, - "name": "guestvlanrange", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "physical network id of the guest VLAN range", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -27983,45 +29690,30 @@ "type": "uuid" }, { - "description": "physical network id of the guest VLAN range", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "zone of the guest VLAN range", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list dedicated guest vlan ranges by id", + "description": "", "length": 255, - "name": "id", - "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "dedicateGuestVlanRange", "response": [ { - "description": "the project id of the guest vlan range", - "name": "projectid", - "type": "string" - }, - { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -28030,8 +29722,13 @@ "type": "string" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, { @@ -28040,35 +29737,35 @@ "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" }, { "description": "the zone of the guest vlan range", "name": "zoneid", "type": "long" }, - {}, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" }, + {}, { "description": "the project name of the guest vlan range", "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" } ] @@ -28079,27 +29776,25 @@ "name": "listNetworkACLs", "params": [ { - "description": "list network ACL items by ACL ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list network ACL items by protocol", + "description": "list network ACL items by action", "length": 255, - "name": "protocol", + "name": "action", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list network ACL items by network ID", @@ -28110,123 +29805,181 @@ "type": "uuid" }, { - "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.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "traffictype", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "tags", + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list network ACL items by action", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "action", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "List by keyword", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list network ACL items by protocol", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "account", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ + { + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" + }, + {}, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, { "description": "the protocol of the ACL", "name": "protocol", "type": "string" }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "type": "string" + }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -28235,51 +29988,46 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { @@ -28287,65 +30035,14 @@ "name": "aclname", "type": "string" }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - {}, { "description": "the ending port of ACL's port range", "name": "endport", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -28356,20 +30053,12 @@ "name": "copyTemplate", "params": [ { - "description": "Template ID.", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", "length": 255, - "name": "destzoneids", + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "list" + "type": "uuid" }, { "description": "ID of the zone the template is being copied to.", @@ -28380,65 +30069,73 @@ "type": "uuid" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", "length": 255, - "name": "sourcezoneid", + "name": "destzoneids", "related": "createZone,updateZone,listZones,listZones", "required": false, + "type": "list" + }, + { + "description": "Template ID.", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, "type": "uuid" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ - {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" }, + {}, { "description": "the ID of the zone for this template", "name": "zoneid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { @@ -28446,84 +30143,146 @@ "name": "userdataid", "type": "string" }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, { "description": "true if template is sshkey enabled, false otherwise", "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], "type": "set" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -28536,50 +30295,36 @@ "name": "displaytext", "type": "string" }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, { "description": "if Datadisk template, then id of the root disk template this template belongs to", "name": "parenttemplateid", "type": "string" }, + {}, { - "description": "the project id of the template", - "name": "projectid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { "description": "checksum of the template", @@ -28587,54 +30332,55 @@ "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "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", + "name": "userdataparams", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, + {}, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { "description": "path of the Domain the template belongs to", @@ -28642,92 +30388,59 @@ "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "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", - "name": "userdataparams", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" } ] }, @@ -28736,13 +30449,6 @@ "isasync": false, "name": "listNiciraNvpDeviceNetworks", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -28757,6 +30463,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "nicira nvp device ID", "length": 255, @@ -28768,111 +30481,116 @@ ], "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ + {}, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the type of the network", - "name": "type", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", @@ -28880,50 +30598,121 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, - {}, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, + {}, { - "description": "the owner of the network", - "name": "account", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "AS NUMBER", @@ -28931,33 +30720,33 @@ "type": "long" }, { - "description": "the id of the network", - "name": "id", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -28966,39 +30755,44 @@ "type": "resourceiconresponse" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", + "name": "ip6routes", "type": "set" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { "description": "The external id of the network", @@ -29006,180 +30800,69 @@ "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", @@ -29191,18 +30874,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -29215,92 +30893,117 @@ "name": "project", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the project name of the address", - "name": "project", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" } ] @@ -29321,22 +31024,22 @@ ], "response": [ {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -29353,23 +31056,17 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list network offerings by enabled state", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" - }, - { - "description": "", + "description": "list ovs elements by network service provider id", "length": 255, - "name": "pagesize", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list ovs elements by id", @@ -29379,6 +31076,13 @@ "required": false, "type": "uuid" }, + { + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, { "description": "List by keyword", "length": 255, @@ -29387,30 +31091,24 @@ "type": "string" }, { - "description": "list ovs elements by network service provider id", + "description": "", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "configureOvsElement", "response": [ { - "description": "the account associated with the provider", - "name": "account", - "type": "string" - }, - { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the id of the ovs", @@ -29418,40 +31116,45 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the project name of the address", + "name": "project", "type": "string" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the account associated with the provider", + "name": "account", + "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" } ] @@ -29461,13 +31164,6 @@ "isasync": true, "name": "associateUcsProfileToBlade", "params": [ - { - "description": "profile dn", - "length": 255, - "name": "profiledn", - "required": true, - "type": "string" - }, { "description": "blade id", "length": 255, @@ -29483,18 +31179,25 @@ "related": "listUcsManagers,addUcsManager", "required": true, "type": "uuid" + }, + { + "description": "profile dn", + "length": 255, + "name": "profiledn", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "ucs blade dn", - "name": "bladedn", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -29502,74 +31205,57 @@ "name": "id", "type": "string" }, - { - "description": "associated ucs profile dn", - "name": "profiledn", - "type": "string" - }, { "description": "cloudstack host id this blade associates to", "name": "hostid", "type": "string" }, {}, - {}, + { + "description": "ucs manager id", + "name": "ucsmanagerid", + "type": "string" + }, + { + "description": "ucs blade dn", + "name": "bladedn", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { - "description": "Checks the 2FA code for the user.", + "description": "Updates a VMware datacenter details for a zone", "isasync": false, - "name": "validateUserTwoFactorAuthenticationCode", + "name": "updateVmwareDc", "params": [ { - "description": "two factor authentication code", + "description": "The zone ID", "length": 255, - "name": "codefor2fa", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "type": "uuid" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The password for specified username.", + "length": 255, + "name": "password", + "required": false, "type": "string" - } - ], - "since": "4.18.0" - }, - { - "description": "Updates a VMware datacenter details for a zone", - "isasync": false, - "name": "updateVmwareDc", - "params": [ + }, { "description": "The username required to connect to resource.", "length": 255, @@ -29584,48 +31270,27 @@ "required": false, "type": "string" }, - { - "description": "The zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, { "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", "length": 255, "name": "vcenter", "required": false, "type": "string" - }, - { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" } ], "related": "addVmwareDc,listVmwareDcs", "response": [ - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" - }, { "description": "The VMware vCenter name/ip", "name": "vcenter", "type": "string" }, + {}, + { + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -29637,32 +31302,63 @@ "type": "integer" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, {}, - {}, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" } ], "since": "4.12.0" }, { - "description": "Starts a router.", + "description": "Checks the 2FA code for the user.", "isasync": false, - "name": "getRouterHealthCheckResults", + "name": "validateUserTwoFactorAuthenticationCode", "params": [ { - "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "description": "two factor authentication code", "length": 255, - "name": "performfreshchecks", - "required": false, + "name": "codefor2fa", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.18.0" + }, + { + "description": "Starts a router.", + "isasync": false, + "name": "getRouterHealthCheckResults", + "params": [ { "description": "the ID of the router", "length": 255, @@ -29670,21 +31366,27 @@ "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" + }, + { + "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "length": 255, + "name": "performfreshchecks", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the id of the router", - "name": "routerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the router", + "name": "routerid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -29695,7 +31397,8 @@ "description": "the id of the router", "name": "healthchecks", "type": "list" - } + }, + {} ], "since": "4.14.0" }, @@ -29704,13 +31407,6 @@ "isasync": false, "name": "listNetscalerControlCenter", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -29724,21 +31420,18 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ - { - "description": "username", - "name": "username", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "ncc_ip", "name": "ipaddress", @@ -29749,12 +31442,6 @@ "name": "numretries", "type": "string" }, - { - "description": "id", - "name": "id", - "type": "string" - }, - {}, { "description": "uuid", "name": "uuid", @@ -29764,6 +31451,22 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "id", + "name": "id", + "type": "string" + }, + { + "description": "username", + "name": "username", + "type": "string" } ] }, @@ -29773,13 +31476,28 @@ "name": "resizeVolume", "params": [ { - "description": "new disk offering id", + "description": "Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "automigrate", "required": false, + "since": "4.20.1", + "type": "boolean" + }, + { + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, "type": "uuid" }, + { + "description": "New minimum number of IOPS", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + }, { "description": "Verify OK to Shrink", "length": 255, @@ -29795,32 +31513,17 @@ "type": "long" }, { - "description": "New volume size in GB", + "description": "new disk offering id", "length": 255, - "name": "size", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "type": "long" - }, - { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, "type": "uuid" }, { - "description": "Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size", - "length": 255, - "name": "automigrate", - "required": false, - "since": "4.20.1", - "type": "boolean" - }, - { - "description": "New minimum number of IOPS", + "description": "New volume size in GB", "length": 255, - "name": "miniops", + "name": "size", "required": false, "type": "long" } @@ -29828,74 +31531,8 @@ "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -29904,13 +31541,8 @@ "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "the status of the volume", + "name": "status", "type": "string" }, { @@ -29918,35 +31550,34 @@ "name": "displayvolume", "type": "boolean" }, - {}, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { @@ -29955,13 +31586,13 @@ "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { @@ -29970,123 +31601,134 @@ "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + {}, + { + "description": "the date the disk volume was created", + "name": "created", "type": "date" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -30095,58 +31737,43 @@ "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, { "description": "the boolean state of whether the volume is destroyed or not", "name": "destroyed", "type": "boolean" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -30155,9 +31782,14 @@ "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { "description": "true if storage snapshot is supported for the volume, false otherwise", @@ -30165,37 +31797,32 @@ "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -30204,13 +31831,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -30219,8 +31846,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -30229,13 +31856,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -30244,40 +31866,120 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" - } - ] - }, - { - "description": "Deletes affinity group", - "isasync": true, - "name": "deleteAffinityGroup", - "params": [ - { - "description": "the project of the affinity group", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" }, { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", - "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "uuid" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the domain ID of account owning the affinity group", - "length": 255, - "name": "domainid", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + {}, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + } + ] + }, + { + "description": "Deletes affinity group", + "isasync": true, + "name": "deleteAffinityGroup", + "params": [ + { + "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID of account owning the affinity group", + "length": 255, + "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" @@ -30290,37 +31992,170 @@ "type": "string" }, { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", + "description": "the project of the affinity group", "length": 255, - "name": "name", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, - {}, + {} + ] + }, + { + "description": "Add NSX Controller to CloudStack", + "isasync": false, + "name": "addNsxController", + "params": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Username to log into NSX controller", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "Edge Cluster name", + "length": 255, + "name": "edgecluster", + "required": true, + "type": "string" + }, + { + "description": "NSX controller port", + "length": 255, + "name": "nsxproviderport", + "required": false, + "type": "string" + }, + { + "description": "Password to login into NSX controller", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "NSX controller hostname / IP address", + "length": 255, + "name": "nsxproviderhostname", + "required": true, + "type": "string" + }, + { + "description": "Tier-0 Gateway address", + "length": 255, + "name": "tier0gateway", + "required": true, + "type": "string" + }, + { + "description": "NSX controller / provider name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Transport Zone controls to which hosts a logical switch can reach", + "length": 255, + "name": "transportzone", + "required": true, + "type": "string" + } + ], + "related": "listNsxControllers,deleteNsxController", + "response": [ + { + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "NSX controller name", + "name": "name", + "type": "string" + }, + { + "description": "NSX controller port", + "name": "port", + "type": "string" + }, + { + "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", + "name": "edgecluster", + "type": "string" + }, + {}, + { + "description": "NSX controller ID", + "name": "nsxprovideruuid", + "type": "string" + }, + { + "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", + "name": "transportzone", + "type": "string" + }, + { + "description": "Zone ID to which the NSX controller is associated with", + "name": "zoneid", + "type": "string" + }, + { + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "NSX controller hostname or IP address", + "name": "hostname", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ] + ], + "since": "4.19.0" }, { "description": "Deletes a network offering.", @@ -30337,28 +32172,28 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "3.0.0" }, @@ -30367,6 +32202,14 @@ "isasync": true, "name": "updateStorageNetworkIpRange", "params": [ + { + "description": "UUID of storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "required": true, + "type": "uuid" + }, { "description": "the ending IP address", "length": 255, @@ -30375,12 +32218,11 @@ "type": "string" }, { - "description": "UUID of storage network ip range", + "description": "the beginning IP address", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" + "name": "startip", + "required": false, + "type": "string" }, { "description": "Optional. the vlan the ip range sits on", @@ -30395,74 +32237,67 @@ "name": "netmask", "required": false, "type": "string" - }, - { - "description": "the beginning IP address", - "length": 255, - "name": "startip", - "required": false, - "type": "string" } ], "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ - { - "description": "the netmask of the storage network IP range", - "name": "netmask", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" + }, + { + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, {}, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" + }, { "description": "the Zone uuid of the storage network IP range", "name": "zoneid", "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the start ip of the storage network IP range", "name": "startip", "type": "string" }, - { - "description": "the network uuid of storage network IP range", - "name": "networkid", - "type": "string" - }, { "description": "the uuid of storage network IP range.", "name": "id", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" - }, - {} + } ], "since": "3.0.0" }, @@ -30472,11 +32307,12 @@ "name": "dedicatePod", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "the ID of the containing domain", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { "description": "the ID of the Pod", @@ -30487,141 +32323,176 @@ "type": "uuid" }, { - "description": "the ID of the containing domain", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" } ], "related": "listDedicatedPods", "response": [ - {}, - { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, - {}, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" } ] }, { - "description": "Synchronize Tungsten-Fabric data", + "description": "Creates a GPU card definition in the system", "isasync": false, - "name": "synchronizeTungstenFabricData", + "name": "createGpuCard", "params": [ { - "description": "provider id", + "description": "the display name of the GPU card", "length": 255, - "name": "id", - "related": "createTungstenFabricProvider,listTungstenFabricProviders", + "name": "name", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "the device name of the GPU card", + "length": 255, + "name": "devicename", + "required": true, + "type": "string" + }, + { + "description": "the device ID of the GPU card", + "length": 255, + "name": "deviceid", + "required": true, + "type": "string" + }, + { + "description": "the video RAM size in MB for the passthrough vGPU profile", + "length": 255, + "name": "videoram", + "required": false, + "type": "long" + }, + { + "description": "the vendor name of the GPU card", + "length": 255, + "name": "vendorname", + "required": true, + "type": "string" + }, + { + "description": "the vendor ID of the GPU card", + "length": 255, + "name": "vendorid", + "required": true, + "type": "string" } ], + "related": "updateGpuCard,listGpuCards", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the device name of the GPU card", + "name": "devicename", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, + { + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Purge expunged resources", - "isasync": true, - "name": "purgeExpungedResources", - "params": [ - { - "description": "The size of batch used during purging", - "length": 255, - "name": "batchsize", - "required": false, - "type": "long" }, + {}, { - "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", - "length": 255, - "name": "resourcetype", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The end date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" + "description": "the ID of the GPU card", + "name": "id", + "type": "string" }, { - "description": "The start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Synchronize Tungsten-Fabric data", + "isasync": false, + "name": "synchronizeTungstenFabricData", + "params": [ + { + "description": "provider id", "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "name": "id", + "related": "createTungstenFabricProvider,listTungstenFabricProviders", + "required": true, + "type": "uuid" } ], "response": [ - {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -30633,347 +32504,354 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ], - "since": "4.20" + ] }, { - "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", - "isasync": true, - "name": "changeOfferingForVolume", + "description": "Lists all available vGPU profiles", + "isasync": false, + "name": "listVgpuProfiles", "params": [ { - "description": "the ID of the volume", + "description": "ID of the vGPU profile", "length": 255, "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, + "related": "createVgpuProfile,updateVgpuProfile,listVgpuProfiles", + "required": false, "type": "uuid" }, { - "description": "new disk offering id", + "description": "List by keyword", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "If true, only vGPU profiles which have a device will be listed. If false, all vGPU profiles will be listed.", "length": 255, - "name": "maxiops", + "name": "activeonly", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Verify OK to Shrink", + "description": "", "length": 255, - "name": "shrinkok", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "", "length": 255, - "name": "miniops", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "New volume size in GB for the custom disk offering", + "description": "the GPU card ID associated with this GPU device", "length": 255, - "name": "size", + "name": "gpucardid", + "related": "updateGpuCard,listGpuCards", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "description": "name of the vGPU profile", "length": 255, - "name": "automigrate", + "name": "name", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "related": "createVgpuProfile,updateVgpuProfile", "response": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the vGPU profile", + "name": "gpucardname", "type": "string" }, + {}, + {}, { - "description": "size of the disk volume", - "name": "size", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the description of the vGPU profile", + "name": "description", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", + "type": "long" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + } + ], + "since": "4.21.0" + }, + { + "description": "Purge expunged resources", + "isasync": true, + "name": "purgeExpungedResources", + "params": [ { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "The size of batch used during purging", + "length": 255, + "name": "batchsize", + "required": false, "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "The end date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "The start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", + "length": 255, + "name": "resourcetype", + "required": false, "type": "string" - }, + } + ], + "response": [ { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {} + ], + "since": "4.20" + }, + { + "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", + "isasync": true, + "name": "changeOfferingForVolume", + "params": [ { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "New volume size in GB for the custom disk offering", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "new disk offering id", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, "type": "boolean" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + } + ], + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - {}, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { "description": "details for the volume check result, they may vary for different hypervisors", @@ -30981,18 +32859,18 @@ "type": "map" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -31001,18 +32879,13 @@ "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -31020,28 +32893,28 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -31050,13 +32923,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -31065,351 +32938,480 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" - } - ], - "since": "4.17" - }, - { - "description": "Remove an Ldap Configuration", - "isasync": false, - "name": "deleteLdapConfiguration", - "params": [ - { - "description": "port", - "length": 255, - "name": "port", - "required": false, - "type": "integer" }, { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" - } - ], - "related": "addLdapConfiguration,listLdapConfigurations", - "response": [ + }, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "linked domain", - "name": "domainid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Creates a Project role", - "isasync": false, - "name": "createProjectRole", - "params": [ { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": true, + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "The description of the Project role", - "length": 255, - "name": "description", - "required": false, + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - } - ], - "related": "listProjectRoles,updateProjectRole", - "response": [ - { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "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).", - "name": "ispublic", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the ID of the role", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, {}, - {}, { - "description": "the id of the project", - "name": "projectid", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the role", - "name": "name", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], - "since": "4.15.0" + "since": "4.17" }, { - "description": "Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC)", - "isasync": true, - "name": "createIpv6FirewallRule", + "description": "Remove an Ldap Configuration", + "isasync": false, + "name": "deleteLdapConfiguration", "params": [ { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "linked domain", "length": 255, - "name": "protocol", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", "required": true, "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "port", "length": 255, - "name": "startport", + "name": "port", "required": false, "type": "integer" + } + ], + "related": "addLdapConfiguration,listLdapConfigurations", + "response": [ + {}, + { + "description": "linked domain", + "name": "domainid", + "type": "string" }, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ending port of Ipv6 firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "name of the host running the ldap server", + "name": "hostname", + "type": "string" }, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Creates a Project role", + "isasync": false, + "name": "createProjectRole", + "params": [ { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "creates a project role with this unique name", "length": 255, - "name": "traffictype", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "The description of the Project role", "length": 255, - "name": "destcidrlist", + "name": "description", "required": false, - "type": "list" + "type": "string" }, { - "description": "The network of the VM the Ipv6 firewall rule will be created for", + "description": "ID of project where role is being created", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" - }, - { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "listProjectRoles,updateProjectRole", "response": [ { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "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).", + "name": "ispublic", + "type": "boolean" }, + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the description of the role", + "name": "description", "type": "string" }, - {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the project", + "name": "projectid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ], + "since": "4.15.0" + }, + { + "description": "Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC)", + "isasync": true, + "name": "createIpv6FirewallRule", + "params": [ + { + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "destcidrlist", + "required": false, + "type": "list" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, - {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "the id of the guest network the port forwarding rule belongs to", + "description": "The network of the VM the Ipv6 firewall rule will be created for", + "length": 255, "name": "networkid", - "type": "string" - }, + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "response": [ { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { @@ -31418,13 +33420,13 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { @@ -31432,18 +33434,18 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -31452,13 +33454,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -31467,13 +33464,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -31482,22 +33479,99 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" - } + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + {} ] }, { - "description": "Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced", + "description": "Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobs have been completed.", "isasync": false, "name": "triggerShutdown", "params": [ { - "description": "the uuid of the management server", + "description": "the id of the management server", "length": 255, "name": "managementserverid", "related": "listManagementServers", @@ -31505,39 +33579,59 @@ "type": "uuid" } ], - "related": "cancelShutdown,prepareForShutdown,readyForShutdown", + "related": "prepareForMaintenance,cancelMaintenance,prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ { - "description": "The number of jobs in progress", - "name": "pendingjobscount", + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" }, - {}, { "description": "The id of the management server", "name": "managementserverid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Indicates whether CloudStack is ready to shutdown", "name": "readyforshutdown", "type": "boolean" }, + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, { "description": "Indicates whether a shutdown has been triggered", "name": "shutdowntriggered", "type": "boolean" + }, + {}, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" } ], "since": "4.19.0" @@ -31548,39 +33642,31 @@ "name": "updateNetwork", "params": [ { - "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "ip6dns2", + "name": "privatemtu", "required": false, "since": "4.18.0", - "type": "string" - }, - { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", - "length": 255, - "name": "guestvmcidr", - "required": false, - "type": "string" + "type": "integer" }, { - "description": "the new display text for the network", + "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", "length": 255, - "name": "displaytext", + "name": "updateinsequence", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the new name for the network", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", "type": "string" }, { - "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", + "description": "Setting this to true will cause a forced network update,", "length": 255, - "name": "updateinsequence", + "name": "forced", "required": false, "type": "boolean" }, @@ -31592,25 +33678,19 @@ "type": "boolean" }, { - "description": "the new name for the network", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "network domain", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "networkdomain", + "name": "displaynetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "displaynetwork", + "name": "publicmtu", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "integer" }, { "description": "the ID of the network", @@ -31621,28 +33701,51 @@ "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", "length": 255, - "name": "publicmtu", + "name": "ip6dns1", "required": false, "since": "4.18.0", - "type": "integer" + "type": "string" }, { - "description": "Setting this to true will cause a forced network update,", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "forced", + "name": "guestvmcidr", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", "length": 255, - "name": "ip6dns1", + "name": "dns2", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "the new display text for the network", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", + "length": 255, + "name": "ip6dns2", "required": false, "since": "4.18.0", "type": "string" }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", "length": 255, @@ -31651,6 +33754,13 @@ "since": "4.18.0", "type": "string" }, + { + "description": "network domain", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, { "description": "Force update even if CIDR type is different", "length": 255, @@ -31673,29 +33783,13 @@ "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, "type": "uuid" - }, - { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "privatemtu", - "required": false, - "since": "4.18.0", - "type": "integer" - }, - { - "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", - "type": "string" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -31704,48 +33798,59 @@ "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { @@ -31754,104 +33859,104 @@ "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "state of the network", + "name": "state", "type": "string" }, - {}, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the type of the network", + "name": "type", "type": "string" }, { @@ -31863,11 +33968,6 @@ "name": "domainpath", "type": "string" }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", @@ -31884,13 +33984,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -31899,13 +33999,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -31917,58 +34022,28 @@ "type": "list" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, { "description": "The routes for the network to ease adding route in upstream router", "name": "ip6routes", "type": "set" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { @@ -31977,123 +34052,128 @@ "type": "boolean" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the owner of the network", - "name": "account", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { "description": "uuid of the network provider", "name": "id", "type": "string" }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", + "description": "the provider name", "name": "name", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the capability value", - "name": "value", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", "type": "string" } ], @@ -32103,18 +34183,13 @@ "type": "list" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { @@ -32123,109 +34198,118 @@ "type": "string" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, - {}, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "related to what other network configuration", + "name": "related", "type": "string" } ] @@ -32236,19 +34320,19 @@ "name": "listBackups", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "id of the VM", "length": 255, - "name": "page", + "name": "virtualmachineid", + "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", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -32266,11 +34350,20 @@ "type": "string" }, { - "description": "", + "description": "list backups by name", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "string" + }, + { + "description": "list backups with VM details", + "length": 255, + "name": "listvmdetails", + "required": false, + "since": "4.21.0", + "type": "boolean" }, { "description": "id of the backup", @@ -32281,21 +34374,35 @@ "type": "uuid" }, { - "description": "list backups by zone id", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "id of the VM", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list backups by backup offering", + "length": 255, + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", "required": false, + "since": "4.21.0", "type": "uuid" }, + { + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -32304,25 +34411,32 @@ "type": "string" }, { - "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.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list backups by zone id", "length": 255, - "name": "isrecursive", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "updateBackupSchedule", "response": [ { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "description for the backup", + "name": "description", + "type": "string" + }, + { + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { @@ -32330,24 +34444,50 @@ "name": "size", "type": "long" }, + { + "description": "backup type", + "name": "type", + "type": "string" + }, + { + "description": "account name", + "name": "account", + "type": "string" + }, + { + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, + { + "description": "backup offering name", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "domain id", "name": "domainid", "type": "string" }, { - "description": "zone id", - "name": "zoneid", + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" }, { - "description": "account name", - "name": "account", - "type": "string" + "description": "backup date", + "name": "created", + "type": "date" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id", + "name": "zoneid", "type": "string" }, { @@ -32355,31 +34495,40 @@ "name": "id", "type": "string" }, + { + "description": "backed up volumes", + "name": "volumes", + "type": "string" + }, + {}, + { + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" + }, { "description": "backup status", "name": "status", "type": "status" }, - {}, { - "description": "external backup id", - "name": "externalid", + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "zone name", - "name": "zone", - "type": "string" + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" }, - {}, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "backup offering id", + "name": "backupofferingid", "type": "string" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -32388,38 +34537,23 @@ "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" - }, - { - "description": "backup date", - "name": "created", - "type": "date" - }, - { - "description": "backed up volumes", - "name": "volumes", + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "backup offering name", - "name": "backupofferingname", + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "backup type", - "name": "type", + "description": "name of the backup", + "name": "name", "type": "string" }, { - "description": "domain name", - "name": "domain", + "description": "zone name", + "name": "zone", "type": "string" } ], @@ -32432,8 +34566,16 @@ "params": [], "related": "", "response": [ - {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Usage type name", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -32449,16 +34591,8 @@ "name": "description", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Usage type name", - "name": "name", - "type": "string" - } + {}, + {} ] }, { @@ -32481,25 +34615,255 @@ "name": "name", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, + { + "description": "the description of the CA service provider", + "name": "description", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.14.0" + }, + { + "description": "delete NSX Controller to CloudStack", + "isasync": false, + "name": "deleteNsxController", + "params": [ + { + "description": "NSX Controller ID", + "length": 255, + "name": "nsxcontrollerid", + "related": "listNsxControllers,deleteNsxController", + "required": true, + "type": "uuid" + } + ], + "related": "listNsxControllers", + "response": [ + { + "description": "NSX controller ID", + "name": "nsxprovideruuid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the description of the CA service provider", + "description": "Zone ID to which the NSX controller is associated with", + "name": "zoneid", + "type": "string" + }, + { + "description": "NSX controller hostname or IP address", + "name": "hostname", + "type": "string" + }, + {}, + {}, + { + "description": "NSX controller name", + "name": "name", + "type": "string" + }, + { + "description": "NSX controller port", + "name": "port", + "type": "string" + }, + { + "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", + "name": "edgecluster", + "type": "string" + }, + { + "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", + "name": "transportzone", + "type": "string" + }, + { + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", + "type": "string" + }, + { + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Updates an existing GUI theme.", + "isasync": false, + "name": "updateGuiTheme", + "params": [ + { + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "css", + "required": false, + "type": "string" + }, + { + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "domainids", + "required": false, + "type": "string" + }, + { + "description": "A name to identify the theme.", + "length": 2048, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "length": 65535, + "name": "commonnames", + "required": false, + "type": "string" + }, + { + "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", + "length": 255, + "name": "recursivedomains", + "required": false, + "type": "boolean" + }, + { + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "jsonconfiguration", + "required": false, + "type": "string" + }, + { + "description": "The ID of the theme to be updated.", + "length": 255, + "name": "id", + "related": "listGuiThemes,updateGuiTheme,createGuiTheme", + "required": true, + "type": "uuid" + }, + { + "description": "A description for the theme.", + "length": 4096, "name": "description", + "required": false, + "type": "string" + }, + { + "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`.", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "accountids", + "required": false, "type": "string" } ], - "since": "4.14.0" + "related": "listGuiThemes,createGuiTheme", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", + "type": "string" + }, + { + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "ID of the custom GUI theme.", + "name": "id", + "type": "string" + }, + { + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", + "type": "string" + }, + { + "description": "Description of the GUI theme.", + "name": "description", + "type": "string" + }, + { + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", + "type": "string" + }, + {}, + { + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" + }, + { + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" + }, + { + "description": "Name of the GUI theme.", + "name": "name", + "type": "string" + }, + { + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", + "type": "string" + }, + {}, + { + "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`.", + "name": "ispublic", + "type": "boolean" + } + ], + "since": "4.21.0.0" }, { "description": "Deletes a VPC", @@ -32516,12 +34880,6 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -32537,6 +34895,12 @@ "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, {} ] }, @@ -32545,19 +34909,27 @@ "isasync": true, "name": "migrateVirtualMachine", "params": [ + { + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, { "description": "the ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "uuid" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, @@ -32568,80 +34940,117 @@ "required": false, "since": "4.16.0", "type": "boolean" - }, - { - "description": "Destination Host ID to migrate VM to.", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,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,importUnmanagedInstance,importVm", + "related": "assignVirtualMachine,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", "response": [ { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, { "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the account owning the affinity group", + "name": "account", + "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -32649,62 +35058,107 @@ "name": "id", "type": "string" }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { @@ -32712,57 +35166,17 @@ "name": "securitygroup", "response": [ { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -32775,16 +35189,6 @@ "name": "cidr", "type": "string" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -32795,119 +35199,129 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "tag value", "name": "value", @@ -32929,32 +35343,42 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "tag key name", "name": "key", "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the starting IP of the security group rule", @@ -32962,8 +35386,8 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -32971,27 +35395,52 @@ "name": "endport", "type": "integer" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -32999,38 +35448,38 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -33039,39 +35488,34 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { @@ -33080,163 +35524,290 @@ "type": "resourceiconresponse" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", "type": "date" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + } + ], + "type": "set" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -33245,13 +35816,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -33259,92 +35830,108 @@ "name": "key", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, + {}, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -33353,278 +35940,115 @@ "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - } - ], - "type": "set" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, + {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { "description": "the name of the domain in which the virtual machine exists", @@ -33632,52 +36056,92 @@ "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" } ] }, + { + "description": "Manages a GPU device", + "isasync": false, + "name": "manageGpuDevice", + "params": [ + { + "description": "comma separated list of IDs of the GPU device", + "length": 255, + "name": "ids", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "list" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} + ], + "since": "4.21.0" + }, { "description": "Deletes a Kubernetes cluster", "isasync": true, @@ -33693,28 +36157,28 @@ } ], "response": [ + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ] }, { @@ -33747,27 +36211,27 @@ "related": "addBaremetalRct", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of rct", + "name": "id", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "id of rct", - "name": "id", - "type": "string" - }, { "description": "url", "name": "url", "type": "string" }, - {} + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -33790,6 +36254,12 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, { "description": "the CA service provider name", @@ -33800,13 +36270,7 @@ "description": "the description of the CA service provider", "name": "description", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ], "since": "4.11.0" }, @@ -33825,28 +36289,28 @@ } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ] }, { @@ -33855,56 +36319,57 @@ "name": "listPortForwardingRules", "params": [ { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "the ID of IP address of the port forwarding services", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "account", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.3", "type": "uuid" }, { @@ -33916,88 +36381,94 @@ "type": "boolean" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "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.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "list port forwarding rules for certain network", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" } ], - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "response": [ { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + {}, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { @@ -34006,29 +36477,29 @@ "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "tag value", "name": "value", @@ -34040,13 +36511,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -34055,59 +36526,52 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the id of the guest network the port forwarding rule belongs to", "name": "networkid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -34136,52 +36600,52 @@ "related": "", "response": [ { - "description": "MAC address of the pod the IP", - "name": "hostmac", - "type": "long" - }, - { - "description": "Allocated IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "nicid", + "description": "the ID of the pod the IP address belongs to", + "name": "podid", "type": "long" }, + {}, { "description": "the ID of the pod the IP address", "name": "id", "type": "long" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", + "description": "CIDR of the Pod", + "name": "cidr", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "nicid", "type": "long" }, { - "description": "CIDR of the Pod", - "name": "cidr", + "description": "Allocated IP address", + "name": "ipaddress", "type": "string" }, {}, + { + "description": "MAC address of the pod the IP", + "name": "hostmac", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Gateway for Pod ", "name": "gateway", "type": "string" - }, - {} + } ] }, { @@ -34200,72 +36664,72 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ - {}, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "the operation result", + "name": "status", "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" } ], "since": "4.9.0" @@ -34276,11 +36740,12 @@ "name": "updateTemplatePermissions", "params": [ { - "description": "true for featured template/iso, false otherwise", + "description": "the template ID", "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { "description": "permission operator (add, remove, reset)", @@ -34297,34 +36762,33 @@ "type": "list" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ispublic", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "ispublic", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "isextractable", + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the template ID", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "name": "isextractable", + "required": false, + "type": "boolean" } ], "response": [ @@ -34333,6 +36797,11 @@ "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "true if operation is executed successfully", @@ -34344,11 +36813,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -34357,14 +36821,6 @@ "isasync": true, "name": "resetPasswordForVirtualMachine", "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, @@ -34372,49 +36828,61 @@ "required": false, "since": "4.19.0", "type": "string" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,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", + "required": true, + "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,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,importUnmanagedInstance,importVm", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,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": [ { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { @@ -34423,43 +36891,43 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { @@ -34468,48 +36936,302 @@ "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -34518,18 +37240,18 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -34538,33 +37260,99 @@ "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + {}, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -34573,8 +37361,44 @@ "type": "map" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -34582,61 +37406,269 @@ "name": "domain", "type": "string" }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + {}, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -34645,47 +37677,52 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { "description": "the ending IP of the security group rule ", @@ -34693,30 +37730,70 @@ "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -34725,18 +37802,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -34750,46 +37827,31 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -34798,8 +37860,13 @@ "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -34807,32 +37874,37 @@ "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -34841,28 +37913,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -34871,31 +37943,26 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -34904,575 +37971,72 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" } ], "type": "set" }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - {}, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" - }, + } + ] + }, + { + "description": "Deletes an OS category", + "isasync": false, + "name": "deleteOsCategory", + "params": [ { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - } - ], - "type": "set" - }, + "description": "ID of the OS category", + "length": 255, + "name": "id", + "related": "listOsCategories,addOsCategory", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, + {}, {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ] + ], + "since": "4.21.0" }, { "description": "Lists Brocade VCS Switches", @@ -35480,54 +38044,61 @@ "name": "listBrocadeVcsDevices", "params": [ { - "description": "List by keyword", + "description": "Brocade VCS switch ID", "length": 255, - "name": "keyword", + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the Physical Network ID", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Brocade VCS switch ID", + "description": "", "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" + }, + {}, { "description": "device id of the Brocade Vcs", "name": "vcsdeviceid", "type": "string" }, + {}, { - "description": "the principal switch Ip address", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the physical Network to which this Brocade VCS belongs to", @@ -35535,25 +38106,18 @@ "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "name of the provider", - "name": "provider", + "description": "device name", + "name": "brocadedevicename", "type": "string" } ] @@ -35564,16 +38128,24 @@ "name": "linkDomainToLdap", "params": [ { - "description": "domain admin username in LDAP ", + "description": "type of the ldap name. GROUP or OU", "length": 255, - "name": "admin", - "required": false, + "name": "type", + "required": true, "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "The id of the domain which has to be linked to LDAP.", "length": 255, - "name": "ldapdomain", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + }, + { + "description": "domain admin username in LDAP ", + "length": 255, + "name": "admin", "required": false, "type": "string" }, @@ -35584,40 +38156,48 @@ "required": true, "type": "integer" }, - { - "description": "The id of the domain which has to be linked to LDAP.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, - "type": "uuid" - }, { "description": "name of the group or OU in LDAP", "length": 255, - "name": "name", + "name": "ldapdomain", "required": false, "type": "string" }, { - "description": "type of the ldap name. GROUP or OU", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "type", - "required": true, + "name": "name", + "required": false, "type": "string" } ], "related": "linkAccountToLdap", "response": [ + {}, + { + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" + }, { "description": "Domain Admin accountId that is created", "name": "accountid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, { @@ -35626,39 +38206,108 @@ "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "id of the Domain which is linked to LDAP", "name": "domainid", "type": "string" + } + ], + "since": "4.6.0" + }, + { + "description": "Cancels maintenance of the management server", + "isasync": false, + "name": "cancelMaintenance", + "params": [ + { + "description": "the id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" }, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", - "type": "string" + "description": "Rebalance agents (applicable for indirect agents, ensure the settings 'host' and 'indirect.agent.lb.algorithm' are properly configured) after cancelling maintenance, default is true", + "length": 255, + "name": "rebalance", + "required": false, + "type": "boolean" + } + ], + "related": "prepareForMaintenance,prepareForShutdown,cancelShutdown,readyForShutdown", + "response": [ + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - } + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" + }, + {}, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" + }, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, + {} ], - "since": "4.6.0" + "since": "4.21.0" }, { "description": "Setup the 2FA for the user.", "isasync": false, "name": "setupUserTwoFactorAuthentication", "params": [ + { + "description": "two factor authentication code", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, { "description": "Enabled by default, provide false to disable 2FA", "length": 255, @@ -35673,32 +38322,21 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" - }, - { - "description": "two factor authentication code", - "length": 255, - "name": "provider", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user name", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "secret code that needs to be registered with authenticator", @@ -35711,11 +38349,15 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user ID", + "name": "id", + "type": "string" }, - {} + { + "description": "the user name", + "name": "username", + "type": "string" + } ], "since": "4.18.0" }, @@ -35725,55 +38367,47 @@ "name": "listVpnCustomerGateways", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "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.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "id of the customer gateway", + "description": "", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -35784,45 +38418,62 @@ "type": "uuid" }, { - "description": "List by keyword", + "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.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "id of the customer gateway", + "length": 255, + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": false, + "type": "uuid" } ], "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "response": [ { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { "description": "public ip address id of the customer gateway", @@ -35830,44 +38481,34 @@ "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "the project name", - "name": "project", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { "description": "the project id", @@ -35875,34 +38516,25 @@ "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { "description": "guest ip of the customer gateway", "name": "ipaddress", "type": "string" }, + {}, { - "description": "name of the customer gateway", - "name": "name", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", @@ -35914,6 +38546,16 @@ "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" } ] }, @@ -35923,12 +38565,12 @@ "name": "deleteKubernetesCluster", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "name": "cleanup", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", @@ -35939,36 +38581,36 @@ "type": "boolean" }, { - "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "cleanup", - "required": false, - "since": "4.19.0", - "type": "boolean" + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -35978,55 +38620,48 @@ "name": "listWebhooks", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of the Webhook", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createWebhook,listWebhooks,listWebhookDeliveries", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "The state of the Webhook", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "The state of the Webhook", + "description": "The name of the Webhook", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "The name of the Webhook", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "The scope of the Webhook", @@ -36036,19 +38671,18 @@ "type": "string" }, { - "description": "The ID of the Webhook", + "description": "", "length": 255, - "name": "id", - "related": "createWebhook,listWebhooks,listWebhookDeliveries", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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.", "length": 255, - "name": "account", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -36058,28 +38692,31 @@ "type": "integer" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "related": "createWebhook,listWebhookDeliveries", "response": [ - { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" - }, { "description": "The state of the Webhook", "name": "state", "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { @@ -36088,24 +38725,25 @@ "type": "integer" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "The name of the Webhook", - "name": "name", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, + {}, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { "description": "Whether SSL verification is enabled for the Webhook", @@ -36117,25 +38755,14 @@ "name": "id", "type": "string" }, - { - "description": "The scope of the Webhook", - "name": "scope", - "type": "string" - }, - {}, { "description": "The account associated with the Webhook", "name": "account", "type": "string" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { @@ -36144,8 +38771,8 @@ "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { @@ -36153,56 +38780,24 @@ "name": "secretkey", "type": "string" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Lists and switches to other SAML accounts owned by the SAML user", - "isasync": false, - "name": "listAndSwitchSamlAccount", - "params": [ - { - "description": "Domain uuid", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "User uuid", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of the Webhook", + "name": "name", "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Creates a global load balancer rule", @@ -36210,19 +38805,25 @@ "name": "createGlobalLoadBalancerRule", "params": [ { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "account", "required": false, "type": "string" }, { - "description": "the domain ID associated with the load balancer", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "gslbservicetype", + "required": true, + "type": "string" + }, + { + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", "required": false, - "type": "uuid" + "type": "string" }, { "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", @@ -36231,6 +38832,14 @@ "required": false, "type": "string" }, + { + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "region where the global load balancer is going to be created.", "length": 255, @@ -36239,20 +38848,6 @@ "required": true, "type": "integer" }, - { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "GSLB service type (tcp, udp, http)", - "length": 255, - "name": "gslbservicetype", - "required": true, - "type": "string" - }, { "description": "the description of the load balancer rule", "length": 4096, @@ -36261,104 +38856,78 @@ "type": "string" }, { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "description": "domain name for the GSLB service.", "length": 255, - "name": "account", - "required": false, + "name": "gslbdomainname", + "required": true, "type": "string" }, { - "description": "domain name for the GSLB service.", + "description": "name of the load balancer rule", "length": 255, - "name": "gslbdomainname", + "name": "name", "required": true, "type": "string" } ], "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ - { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" - }, - { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, { "description": "the domain of the load balancer rule", "name": "domain", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" - }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, - {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -36367,28 +38936,28 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -36397,56 +38966,56 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -36455,13 +39024,13 @@ "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -36470,8 +39039,8 @@ "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { @@ -36480,41 +39049,51 @@ "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ], "type": "list" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" + }, + { + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -36523,13 +39102,29 @@ "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, {} @@ -36552,9 +39147,9 @@ "response": [ {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -36566,12 +39161,12 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -36580,62 +39175,54 @@ "name": "listTags", "params": [ { - "description": "list by resource id", + "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.", "length": 255, - "name": "resourceid", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by value", + "description": "list by customer name", "length": 255, - "name": "value", + "name": "customer", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "list by resource type", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "resourcetype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by customer name", + "description": "list by key", "length": 255, - "name": "customer", + "name": "key", "required": false, "type": "string" }, { - "description": "list by key", + "description": "list by value", "length": 255, - "name": "key", + "name": "value", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -36645,26 +39232,34 @@ "type": "integer" }, { - "description": "", + "description": "list by resource id", "length": 255, - "name": "pagesize", + "name": "resourceid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list by resource type", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "resourcetype", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -36676,71 +39271,71 @@ "related": "listResourceDetails", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, - {}, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, + {}, { - "description": "tag value", - "name": "value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" } ], "since": "4.0.0" @@ -36758,21 +39353,6 @@ "required": true, "type": "uuid" }, - { - "description": "the Id of the cluster the scope of the storage pool is being changed to", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -36786,19 +39366,28 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the Id of the cluster the scope of the storage pool is being changed to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the cluster ID for the VM", - "name": "clusterid", - "type": "string" - }, - {}, - { - "description": "the type of VM", - "name": "type", + "description": "the cluster name for the VM", + "name": "clustername", "type": "string" }, { @@ -36807,18 +39396,18 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of VM", + "name": "type", "type": "string" }, { - "description": "the ID of the VM", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cluster name for the VM", - "name": "clustername", + "description": "the hostname for the VM", + "name": "hostname", "type": "string" }, {}, @@ -36827,16 +39416,22 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the VM", + "name": "id", + "type": "string" + }, { "description": "the host ID for the VM", "name": "hostid", "type": "string" }, { - "description": "the hostname for the VM", - "name": "hostname", + "description": "the cluster ID for the VM", + "name": "clusterid", "type": "string" - } + }, + {} ], "since": "4.19.1" }, @@ -36846,80 +39441,80 @@ "name": "createVirtualRouterElement", "params": [ { - "description": "the network service provider ID of the virtual router element", + "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", "length": 255, - "name": "nspid", + "name": "providertype", "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "required": true, + "required": false, "type": "uuid" }, { - "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", + "description": "the network service provider ID of the virtual router element", "length": 255, - "name": "providertype", + "name": "nspid", "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "required": false, + "required": true, "type": "uuid" } ], "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ + {}, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + { + "description": "path of the domain to which the provider belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the physical network service provider id of the provider", "name": "nspid", "type": "string" }, + {}, { "description": "the account associated with the provider", "name": "account", "type": "string" }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, { "description": "the id of the router", "name": "id", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, - {}, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, { "description": "the domain ID associated with the provider", "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { "description": "the domain associated with the provider", "name": "domain", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" } ] }, @@ -36929,35 +39524,28 @@ "name": "createVPC", "params": [ { - "description": "the name of the VPC", + "description": "the ID of the availability zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "the second IPv4 DNS for the VPC", + "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", "length": 255, - "name": "dns2", + "name": "sourcenatipaddress", "required": false, - "since": "4.18.0", + "since": "4.19", "type": "string" }, { - "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.", + "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", "length": 255, - "name": "start", + "name": "cidrsize", "required": false, - "since": "4.3", - "type": "boolean" + "since": "4.20.0", + "type": "integer" }, { "description": "the first IPv6 DNS for the VPC", @@ -36968,35 +39556,33 @@ "type": "string" }, { - "description": "the AS Number of the VPC tiers", + "description": "the second IPv4 DNS for the VPC", "length": 255, - "name": "asnumber", + "name": "dns2", "required": false, - "since": "4.20.0", - "type": "long" + "since": "4.18.0", + "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "sourcenatipaddress", + "name": "cidr", "required": false, - "since": "4.19", "type": "string" }, { - "description": "the ID of the availability zone", + "description": "the AS Number of the VPC tiers", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "asnumber", + "required": false, + "since": "4.20.0", + "type": "long" }, { - "description": "the first IPv4 DNS for the VPC", + "description": "The display text of the VPC, defaults to its 'name'.", "length": 255, - "name": "dns1", + "name": "displaytext", "required": false, - "since": "4.18.0", "type": "string" }, { @@ -37008,18 +39594,25 @@ "type": "uuid" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2", "length": 255, - "name": "publicmtu", + "name": "userouteripresolver", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "boolean" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "description": "the ID of the VPC offering", "length": 255, - "name": "networkdomain", - "required": false, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the VPC", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { @@ -37031,20 +39624,36 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "the first IPv4 DNS for the VPC", "length": 255, - "name": "fordisplay", + "name": "dns1", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "The display text of the VPC, defaults to its 'name'.", + "description": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "displaytext", + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "the second IPv6 DNS for the VPC", + "length": 255, + "name": "ip6dns2", "required": false, + "since": "4.18.0", "type": "string" }, + { + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" + }, { "description": "Ids of the Bgp Peer for the VPC", "length": 255, @@ -37055,19 +39664,20 @@ "type": "list" }, { - "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", + "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.", "length": 255, - "name": "cidrsize", + "name": "start", "required": false, - "since": "4.20.0", - "type": "integer" + "since": "4.3", + "type": "boolean" }, { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "cidr", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "the account associated with the VPC. Must be used with the domainId parameter.", @@ -37075,42 +39685,30 @@ "name": "account", "required": false, "type": "string" - }, - { - "description": "the ID of the VPC offering", - "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", - "required": true, - "type": "uuid" } ], "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, + {}, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -37118,125 +39716,33 @@ "type": "integer" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, - {}, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { @@ -37249,8 +39755,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -37259,8 +39770,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -37268,19 +39779,14 @@ "name": "project", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -37289,67 +39795,81 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, - {}, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", "type": "boolean" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { @@ -37358,13 +39878,13 @@ "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { @@ -37372,15 +39892,21 @@ "name": "ip4routes", "type": "set" }, + {}, { - "description": "the name of the VPC", - "name": "name", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { "description": "state of the VPC. Can be Inactive/Enabled", @@ -37388,34 +39914,110 @@ "type": "string" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "type": "string" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" } ] }, @@ -37424,6 +40026,13 @@ "isasync": true, "name": "removeResourceDetail", "params": [ + { + "description": "Delete detail by resource type", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, { "description": "Delete details matching key/value pairs", "length": 255, @@ -37437,38 +40046,31 @@ "name": "resourceid", "required": true, "type": "string" - }, - { - "description": "Delete detail by resource type", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - {} + } ] }, { @@ -37477,20 +40079,11 @@ "name": "listOsTypes", "params": [ { - "description": "list by Os type Id", - "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "list by Os Category id", + "description": "", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -37500,13 +40093,6 @@ "since": "4.18.1", "type": "boolean" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list os by description", "length": 255, @@ -37528,26 +40114,37 @@ "name": "page", "required": false, "type": "integer" - } - ], - "related": "addGuestOs", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the ID of the OS category", + "description": "list by Os Category id", + "length": 255, "name": "oscategoryid", - "type": "string" + "related": "listOsCategories,addOsCategory", + "required": false, + "type": "uuid" }, - {}, + { + "description": "list by Os type Id", + "length": 255, + "name": "id", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" + } + ], + "related": "addGuestOs", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, + {}, { "description": "the name of the OS category", "name": "oscategoryname", @@ -37555,32 +40152,119 @@ }, {}, { - "description": "the ID of the OS type", - "name": "id", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "the name of the OS type", - "name": "name", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the name of the OS type", + "name": "name", + "type": "string" }, { "description": "is the guest OS visible for the users", "name": "fordisplay", "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, + { + "description": "Updates a GPU card definition in the system", + "isasync": false, + "name": "updateGpuCard", + "params": [ + { + "description": "the vendor name of the GPU card", + "length": 255, + "name": "vendorname", + "required": false, + "type": "string" + }, + { + "description": "the ID of the GPU card", + "length": 255, + "name": "id", + "related": "updateGpuCard,listGpuCards", + "required": true, + "type": "uuid" + }, + { + "description": "the display name of the GPU card", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the device name of the GPU card", + "length": 255, + "name": "devicename", + "required": false, + "type": "string" + } + ], + "related": "listGpuCards", + "response": [ + { + "description": "the vendor name of the GPU card", + "name": "vendorname", + "type": "string" + }, + { + "description": "the device name of the GPU card", + "name": "devicename", + "type": "string" + }, + { + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" + }, + { + "description": "the ID of the GPU card", + "name": "id", + "type": "string" + }, + { + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the display name of the GPU card", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.21.0" + }, { "description": "Removes a Guest OS from listing.", "isasync": true, @@ -37597,9 +40281,9 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -37607,17 +40291,17 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ], "since": "4.4.0" }, @@ -37626,14 +40310,6 @@ "isasync": true, "name": "detachIso", "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "If true, ejects the ISO before detaching on VMware. Default: false", "length": 255, @@ -37641,266 +40317,167 @@ "required": false, "since": "4.15.1", "type": "boolean" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,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", + "required": true, + "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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": [ { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "User VM type", "name": "vmtype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + {}, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, { "description": "Os type ID of the virtual machine", "name": "guestosid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - } - ], - "type": "set" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -37908,8 +40485,13 @@ "name": "securitygroup", "response": [ { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -37918,19 +40500,59 @@ "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -37941,23 +40563,23 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -37966,23 +40588,23 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -37991,56 +40613,98 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "account owning the security group rule", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the ID of the security group", "name": "id", @@ -38051,8 +40715,8 @@ "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -38060,14 +40724,34 @@ "name": "icmpcode", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -38075,8 +40759,13 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -38085,8 +40774,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -38095,18 +40784,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -38115,179 +40799,102 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" } ], "type": "set" }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" } ], "type": "set" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -38296,109 +40903,337 @@ "type": "map" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, + {}, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the affinity group", + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, { "description": "the description of the affinity group", "name": "description", "type": "string" }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the account owning the affinity group", "name": "account", @@ -38410,9 +41245,9 @@ "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { "description": "the name of the affinity group", @@ -38420,121 +41255,181 @@ "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ], "type": "set" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, - {}, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -38543,13 +41438,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -38558,18 +41453,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -38578,170 +41473,136 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" - }, + } + ] + }, + { + "description": "Update the custom action", + "isasync": false, + "name": "updateCustomAction", + "params": [ { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Type of the resource for actions", + "length": 255, + "name": "resourcetype", + "required": false, "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "The description of the command", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "ID of the custom action", + "length": 255, + "name": "id", + "related": "addCustomAction,listCustomActions", + "required": true, + "type": "uuid" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Success message that will be used on successful execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Successfully complete {{actionName}} for {{extensionName", + "length": 255, + "name": "successmessage", + "required": false, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "Optional boolean field, which indicates if parameters should be cleaned up or not (If set to true, parameters will be removed for this action, parameters field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupparameters", + "required": false, + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "List of role types allowed for the action", + "length": 255, + "name": "allowedroletypes", + "required": false, + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether the action is enabled or not", + "length": 255, + "name": "enabled", + "required": false, "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Error message that will be used on failure during execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Failed to complete {{actionName}} for {{extensionName", + "length": 255, + "name": "errormessage", + "required": false, "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this action, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, "type": "boolean" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds", + "length": 255, + "name": "timeout", + "required": false, + "type": "integer" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, + "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", + "length": 255, + "name": "parameters", + "required": false, + "type": "map" + } + ], + "response": [ { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.21.0" }, { "description": " delete a Palo Alto firewall device", @@ -38758,27 +41619,27 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -38788,19 +41649,19 @@ "name": "executeWebhookDelivery", "params": [ { - "description": "The ID of the Webhook", + "description": "Payload of the Webhook delivery", "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "payload", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", + "description": "The ID of the Webhook", "length": 255, - "name": "sslverification", + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "Secret key of the Webhook delivery", @@ -38810,12 +41671,11 @@ "type": "string" }, { - "description": "The ID of the Webhook delivery for redelivery", + "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", "length": 255, - "name": "id", - "related": "executeWebhookDelivery", + "name": "sslverification", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "Payload URL of the Webhook delivery", @@ -38825,23 +41685,19 @@ "type": "string" }, { - "description": "Payload of the Webhook delivery", + "description": "The ID of the Webhook delivery for redelivery", "length": 255, - "name": "payload", + "name": "id", + "related": "executeWebhookDelivery", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The headers of the webhook delivery", - "name": "headers", + "description": "The ID of the event", + "name": "eventid", "type": "string" }, { @@ -38849,9 +41705,15 @@ "name": "webhookname", "type": "string" }, + {}, { - "description": "The type of the event", - "name": "eventtype", + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" + }, + { + "description": "The payload of the webhook delivery", + "name": "payload", "type": "string" }, { @@ -38859,56 +41721,55 @@ "name": "startdate", "type": "date" }, - {}, - { - "description": "The ID of the event", - "name": "eventid", - "type": "string" - }, - { - "description": "The ID of the management server which executed delivery", - "name": "managementserverid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "Whether Webhook delivery succeeded or not", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The end time of the Webhook delivery", + "name": "enddate", + "type": "date" }, { "description": "The ID of the Webhook delivery", "name": "id", "type": "string" }, + { + "description": "The type of the event", + "name": "eventtype", + "type": "string" + }, { "description": "The ID of the Webhook", "name": "webhookid", "type": "string" }, { - "description": "The response of the webhook delivery", - "name": "response", + "description": "The headers of the webhook delivery", + "name": "headers", "type": "string" }, + {}, { - "description": "The name of the management server which executed delivery", - "name": "managementservername", + "description": "The ID of the management server which executed delivery", + "name": "managementserverid", "type": "string" }, { - "description": "The end time of the Webhook delivery", - "name": "enddate", - "type": "date" + "description": "The response of the webhook delivery", + "name": "response", + "type": "string" }, { - "description": "The payload of the webhook delivery", - "name": "payload", + "description": "The name of the management server which executed delivery", + "name": "managementservername", "type": "string" } ], @@ -38930,27 +41791,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + {} ] }, { @@ -38961,49 +41822,40 @@ { "description": "", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createTungstenFabricProvider", "response": [ + {}, { - "description": "Tungsten-Fabric provider name", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if security groups support is enabled, false otherwise", @@ -39011,8 +41863,13 @@ "type": "boolean" }, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -39022,35 +41879,39 @@ }, {}, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "type": "string" } ] }, @@ -39059,13 +41920,6 @@ "isasync": false, "name": "listDeploymentPlanners", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -39079,10 +41933,18 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -39094,7 +41956,6 @@ "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -39117,28 +41978,28 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -39158,196 +42019,131 @@ "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, { "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -39356,99 +42152,142 @@ "type": "string" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, + {}, { - "description": "the host version", - "name": "version", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", "name": "hahost", "type": "boolean" }, + {}, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the host version", + "name": "version", "type": "string" }, { @@ -39456,25 +42295,24 @@ "name": "networkkbswrite", "type": "long" }, - {}, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { @@ -39483,20 +42321,49 @@ "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the name of the host", + "name": "name", "type": "string" }, - {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { "description": "the date and time the host was last pinged", @@ -39504,49 +42371,94 @@ "type": "date" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" } ] }, @@ -39564,28 +42476,28 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { @@ -39608,13 +42520,13 @@ "name": "jobid", "type": "string" }, - {}, - {}, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -39628,20 +42540,20 @@ "name": "updateAutoScaleVmGroup", "params": [ { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" }, { "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", @@ -39650,21 +42562,6 @@ "required": false, "type": "integer" }, - { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "length": 255, - "name": "maxmembers", - "required": false, - "type": "integer" - }, - { - "description": "the name of the autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - }, { "description": "the ID of the autoscale group", "length": 255, @@ -39674,9 +42571,16 @@ "type": "uuid" }, { - "description": "list of scaledown autoscale policies", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", "length": 255, - "name": "scaledownpolicyids", + "name": "maxmembers", + "required": false, + "type": "integer" + }, + { + "description": "list of scaleup autoscale policies", + "length": 255, + "name": "scaleuppolicyids", "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, "type": "list" @@ -39689,9 +42593,17 @@ "type": "integer" }, { - "description": "list of scaleup autoscale policies", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "scaleuppolicyids", + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, "type": "list" @@ -39700,34 +42612,29 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "response": [ { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { "description": "the public ip address", @@ -39735,54 +42642,43 @@ "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - {}, - { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", "type": "int" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "the project name of the vm group", + "name": "project", + "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the private port", - "name": "privateport", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -39791,8 +42687,8 @@ "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { @@ -39805,20 +42701,21 @@ "name": "name", "type": "string" }, + {}, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { "description": "the id of the guest network the lb rule belongs to", @@ -39826,24 +42723,39 @@ "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, + {}, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" } ] @@ -39853,14 +42765,6 @@ "isasync": true, "name": "deleteSnapshot", "params": [ - { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" - }, { "description": "The ID of the zone for the snapshot", "length": 255, @@ -39869,16 +42773,24 @@ "required": false, "since": "4.19.0", "type": "uuid" + }, + { + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "required": true, + "type": "uuid" } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -39890,9 +42802,9 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -39902,65 +42814,84 @@ "name": "listVirtualMachines", "params": [ { - "description": "the host ID", + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list vms by ssh keypair name", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "keypair", + "name": "ids", + "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", "required": false, - "type": "string" + "since": "4.4", + "type": "list" }, { - "description": "the pod ID", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "haenable", + "required": false, + "since": "4.15", + "type": "boolean" + }, + { + "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.", + "length": 255, + "name": "gpuenabled", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "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.", "length": 255, - "name": "tags", + "name": "isvnf", "required": false, - "type": "map" + "since": "4.19.0", + "type": "boolean" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "forvirtualnetwork", + "name": "userdata", "required": false, + "since": "4.18.0.0", "type": "boolean" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "list vms by template", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "the group ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "CPU arch of the VM", + "description": "the cluster ID", "length": 255, - "name": "arch", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.20.1", - "type": "string" + "since": "4.16.0", + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -39971,346 +42902,332 @@ "type": "uuid" }, { - "description": "list vms by template", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "haenable", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "list by the service offering", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the ID of AutoScaling VM Group", + "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "state", "required": false, - "since": "4.18.0", - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "Whether to return only leased instances", "length": 255, - "name": "keyword", + "name": "leased", "required": false, - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "page", + "name": "forvirtualnetwork", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list by network id", + "description": "list vms by ssh keypair name", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "comma separated list of vm 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.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list by the backup offering", + "description": "the instances by userdata", "length": 255, - "name": "backupofferingid", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, - "since": "4.17", + "since": "4.20.1", "type": "uuid" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "the security group ID", "length": 255, - "name": "name", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, - "type": "string" + "since": "4.15", + "type": "uuid" }, { - "description": "", + "description": "list vms by vpc", "length": 255, - "name": "pagesize", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list vms by iso", + "description": "CPU arch of the VM", "length": 255, - "name": "isoid", + "name": "arch", + "required": false, + "since": "4.20.1", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "id", + "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", "required": false, "type": "uuid" }, { - "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.", + "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.", "length": 255, - "name": "isvnf", + "name": "listall", "required": false, - "since": "4.19.0", "type": "boolean" }, { - "description": "flag to display the resource icon for VMs", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "showicon", + "name": "extensionid", + "related": "createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "since": "4.21.0", + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the target hypervisor for the template", "length": 255, - "name": "displayvm", + "name": "hypervisor", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the availability zone ID", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "hypervisor", + "name": "account", "required": false, "type": "string" }, { - "description": "list vms by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "description": "the pod ID", "length": 255, - "name": "accumulate", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "uuid" }, { - "description": "list vms by vpc", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "displayvm", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list by the backup offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "the cluster ID", + "description": "the group ID", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "groupid", + "related": "createInstanceGroup,updateInstanceGroup", "required": false, - "since": "4.16.0", "type": "uuid" }, { - "description": "the instances by userdata", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", "length": 255, - "name": "userdataid", - "related": "", + "name": "accumulate", "required": false, - "since": "4.20.1", - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "description": "list by the service offering", + "description": "the host ID", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, - "since": "4.4", "type": "uuid" }, { - "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.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the virtual machine", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, + "since": "4.18.0", "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "list vms by affinity group", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.4", - "type": "list" + "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "state", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the security group ID", + "description": "list by network id", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.15", "type": "uuid" }, { - "description": "comma separated list of vm 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.", + "description": "list vms by iso", "length": 255, - "name": "details", + "name": "isoid", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "userdata", + "name": "showicon", "required": false, - "since": "4.18.0.0", + "since": "4.16.0.0", "type": "boolean" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "response": [ - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, { "description": "the user's name who deployed the virtual machine", "name": "username", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the project name of the vm", @@ -40318,13 +43235,23 @@ "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { @@ -40333,49 +43260,43 @@ "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { @@ -40384,226 +43305,185 @@ "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - {}, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account owning the affinity group", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -40612,251 +43492,484 @@ "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "name": "publicipid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the ID of the affinity group", + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + {}, + {}, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -40864,18 +43977,8 @@ "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -40883,28 +43986,13 @@ "name": "cidr", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -40913,62 +44001,87 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" @@ -40979,8 +44092,18 @@ "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -40988,52 +44111,42 @@ "name": "ingressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -41042,18 +44155,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -41065,14 +44178,14 @@ "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "the id of the security group rule", @@ -41080,51 +44193,108 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -41135,197 +44305,24 @@ ], "type": "set" }, - {}, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" } ] @@ -41336,25 +44333,18 @@ "name": "listDiskOfferings", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "The ID of the volume, tags of the volume are used to filter the offerings", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, - "since": "4.19", - "type": "string" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, @@ -41368,76 +44358,75 @@ "type": "uuid" }, { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" - }, - { - "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.", + "description": "name of the disk offering", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "virtualmachineid", + "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", "required": false, + "since": "4.20.0", "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "since": "4.19", + "type": "string" }, { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "state", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.19", - "type": "string" + "type": "uuid" }, { - "description": "listed offerings support disk encryption", + "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.", "length": 255, - "name": "encrypt", + "name": "listall", "required": false, - "since": "4.18", "type": "boolean" }, { - "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "since": "4.17", "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -41446,40 +44435,58 @@ "type": "integer" }, { - "description": "name of the disk offering", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "name", + "name": "storagetype", "required": false, + "since": "4.19", "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", + "description": "listed offerings support disk encryption", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "name": "encrypt", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "since": "4.20.0", "type": "uuid" } ], "related": "createDiskOffering", "response": [ { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { "description": "bytes write rate of the disk offering", @@ -41487,14 +44494,14 @@ "type": "long" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "burst io requests read rate of the disk offering", @@ -41502,19 +44509,9 @@ "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { "description": "burst bytes write rate of the disk offering", @@ -41522,19 +44519,14 @@ "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { "description": "length (in seconds) of the burst", @@ -41542,66 +44534,56 @@ "type": "long" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { "description": "true if disk offering uses custom size, false otherwise", "name": "iscustomized", "type": "boolean" }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" - }, { "description": "bytes read rate of the disk offering", "name": "diskBytesReadRate", "type": "long" }, - { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" - }, {}, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "state of the disk offering", - "name": "state", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, + { + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, { "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", "type": "string" }, + { + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, { "description": "the date this disk offering was created", "name": "created", @@ -41613,64 +44595,79 @@ "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, - {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, + {}, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" + }, + { + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" } ] @@ -41690,27 +44687,27 @@ } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -41739,75 +44736,75 @@ "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "response": [ { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "keypair details", + "name": "keypair", + "type": "string" }, + {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", + "type": "string" }, { "description": "URL end point for the Kubernetes cluster dashboard UI", @@ -41815,48 +44812,48 @@ "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { @@ -41865,20 +44862,19 @@ "type": "integer" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, - {}, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { "description": "Minimum size of the cluster", @@ -41886,23 +44882,33 @@ "type": "long" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { @@ -41911,13 +44917,29 @@ "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { @@ -41926,8 +44948,33 @@ "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" } ] @@ -41938,18 +44985,12 @@ "name": "createCondition", "params": [ { - "description": "the account of the condition. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Value for which the Counter will be evaluated with the Operator selected.", + "description": "ID of the Counter.", "length": 255, - "name": "threshold", + "name": "counterid", + "related": "createCounter,listCounters", "required": true, - "type": "long" + "type": "uuid" }, { "description": "an optional project for condition", @@ -41960,18 +45001,10 @@ "type": "uuid" }, { - "description": "ID of the Counter.", - "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" - }, - { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "description": "the account of the condition. Must be used with the domainId parameter.", "length": 255, - "name": "relationaloperator", - "required": true, + "name": "account", + "required": false, "type": "string" }, { @@ -41981,35 +45014,48 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" + }, + { + "description": "Value for which the Counter will be evaluated with the Operator selected.", + "length": 255, + "name": "threshold", + "required": true, + "type": "long" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", + "required": true, + "type": "string" } ], "related": "listConditions", "response": [ { - "description": "the project name of the Condition", - "name": "project", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, {}, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the id of the Condition", + "name": "id", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", - "type": "string" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "description": "the owner of the Condition.", - "name": "account", - "type": "string" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, { @@ -42018,28 +45064,29 @@ "type": "integer" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, + {}, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -42048,18 +45095,18 @@ "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "the owner of the Condition.", + "name": "account", + "type": "string" }, { - "description": "the id of the Condition", - "name": "id", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" } ] @@ -42070,23 +45117,30 @@ "name": "listProjects", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "list projects by state", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "List projects by username", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "username", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list projects by display text", + "length": 255, + "name": "displaytext", "required": false, "type": "string" }, @@ -42098,44 +45152,44 @@ "type": "map" }, { - "description": "", + "description": "list projects by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list projects by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "account", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "list projects by state", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list projects by display text", + "description": "List projects by username", "length": 255, - "name": "displaytext", + "name": "username", "required": false, "type": "string" }, { - "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.", + "description": "flag to display the resource icon for projects", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, @@ -42148,25 +45202,11 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "flag to display the resource icon for projects", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showicon", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "list projects by project ID", @@ -42175,103 +45215,46 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "response": [ - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, { "description": "the total number of virtual machines deployed by this project", "name": "vmtotal", "type": "long" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", "type": "long" }, { @@ -42279,72 +45262,67 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { "description": "the total number of public ip addresses this project can acquire", @@ -42352,381 +45330,269 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, - {}, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - {}, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of buckets stored by this project", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Creates an account", - "isasync": false, - "name": "createAccount", - "params": [ - { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" - }, - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - }, - { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": false, + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "Network domain for the account's networks", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - } - ], - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of gpus owned by project", + "name": "gputotal", "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, + {}, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { @@ -42735,130 +45601,139 @@ "type": "resourceiconresponse" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates an account", + "isasync": false, + "name": "createAccount", + "params": [ { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "email", + "length": 255, + "name": "email", + "required": true, "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "firstname", + "length": 255, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "Creates the user under the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" }, { - "description": "the state of the account", - "name": "state", + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - {}, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": false, + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": false, "type": "integer" - }, + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "response": [ { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { @@ -42866,34 +45741,39 @@ "name": "user", "response": [ { - "description": "the account ID of the user", - "name": "accountid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { "description": "the name of the role", @@ -42901,43 +45781,43 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user state", + "name": "state", "type": "string" }, { @@ -42946,66 +45826,126 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" } ], "type": "list" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, { "description": "the total memory (in MB) the account can own", "name": "memorylimit", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { @@ -43014,408 +45954,406 @@ "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, { "description": "true if account is default, false otherwise", "name": "isdefault", "type": "boolean" - } - ] - }, - { - "description": "Revert VM from a vmsnapshot.", - "isasync": true, - "name": "revertToVMSnapshot", - "params": [ + }, { - "description": "The ID of the vm snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "response": [ + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, + {}, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the date when this account was created", + "name": "created", + "type": "date" + } + ] + }, + { + "description": "Revert VM from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", + "params": [ + { + "description": "The ID of the vm snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], + "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", + "response": [ + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + {}, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -43424,18 +46362,18 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -43444,78 +46382,78 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { "description": "account owning the security group rule", "name": "account", "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -43524,8 +46462,8 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -43534,27 +46472,32 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -43563,13 +46506,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -43578,72 +46526,159 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -43652,73 +46687,63 @@ "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { @@ -43726,53 +46751,53 @@ "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -43781,83 +46806,88 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -43866,111 +46896,179 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, { "description": "list of variables and values for the variables declared in userdata", "name": "userdatadetails", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -43978,292 +47076,429 @@ "name": "servicestate", "type": "string" }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, {}, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" - } - ], - "since": "4.2.0" - }, - { - "description": "Removes a Guest OS Mapping.", - "isasync": true, - "name": "removeGuestOsMapping", - "params": [ - { - "description": "ID of the guest OS mapping", - "length": 255, - "name": "id", - "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, - {} - ], - "since": "4.4.0" - }, - { - "description": "create Tungsten-Fabric service group", - "isasync": true, - "name": "createTungstenFabricServiceGroup", - "params": [ { - "description": "Tungsten-Fabric service group protocol", - "length": 255, - "name": "protocol", - "required": true, + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Tungsten-Fabric service group start port", - "length": 255, - "name": "startport", - "required": true, - "type": "integer" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "Tungsten-Fabric service group end port", - "length": 255, - "name": "endport", - "required": true, - "type": "integer" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "Tungsten-Fabric service group name", - "length": 255, - "name": "name", - "required": true, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Removes a Guest OS Mapping.", + "isasync": true, + "name": "removeGuestOsMapping", + "params": [ + { + "description": "ID of the guest OS mapping", + "length": 255, + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "create Tungsten-Fabric service group", + "isasync": true, + "name": "createTungstenFabricServiceGroup", + "params": [ + { + "description": "Tungsten-Fabric service group end port", + "length": 255, + "name": "endport", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric service group protocol", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric service group name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric service group start port", + "length": 255, + "name": "startport", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", "type": "string" }, { @@ -44281,10 +47516,32 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, + {}, + { + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" + }, + {}, { "description": "Tungsten-Fabric service group name", "name": "name", "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -44303,22 +47560,22 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -44334,16 +47591,16 @@ "name": "registerIso", "params": [ { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "the checksum value of this 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 \"{}\", not including the double quotes. In this 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.", "length": 255, - "name": "isdynamicallyscalable", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the checksum value of this 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 \"{}\", not including the double quotes. In this 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.", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "checksum", + "name": "account", "required": false, "type": "string" }, @@ -44355,17 +47612,10 @@ "type": "boolean" }, { - "description": "the name of the ISO", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "Register ISO for the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -44377,49 +47627,49 @@ "type": "string" }, { - "description": "the ID of the zone you wish to register the ISO to.", + "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", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, "type": "uuid" }, { - "description": "Image store UUID", + "description": "the name of the ISO", "length": 255, - "name": "imagestoreuuid", - "required": false, - "type": "string" - }, - { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "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", + "description": "the ID of the zone you wish to register the ISO to.", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "ispublic", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "bootable", + "name": "isfeatured", "required": false, "type": "boolean" }, + { + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, @@ -44429,9 +47679,9 @@ "type": "string" }, { - "description": "an optional account name. Must be used with domainId.", + "description": "Image store UUID", "length": 255, - "name": "account", + "name": "imagestoreuuid", "required": false, "type": "string" }, @@ -44443,59 +47693,62 @@ "type": "boolean" }, { - "description": "true if you want this ISO to be featured", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "isfeatured", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "Register ISO for the project", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if password reset feature is supported; default is false", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "passwordenabled", + "name": "ispublic", "required": false, "type": "boolean" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { "description": "path of the Domain the template belongs to", @@ -44503,8 +47756,13 @@ "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { @@ -44513,84 +47771,112 @@ "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, - {}, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, { "description": "true if the template is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, - {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -44603,38 +47889,54 @@ "name": "value", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, + {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "the ID of the domain to which the template belongs", @@ -44642,28 +47944,23 @@ "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the template name", + "name": "name", "type": "string" }, { @@ -44672,18 +47969,8 @@ "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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", - "name": "userdataparams", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { @@ -44691,19 +47978,30 @@ "name": "childtemplates", "type": "set" }, + {}, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { @@ -44712,8 +48010,8 @@ "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { @@ -44722,14 +48020,14 @@ "type": "resourceiconresponse" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", @@ -44737,74 +48035,49 @@ "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "additional key/value details tied with template", - "name": "details", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", "type": "map" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", + "name": "userdataparams", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" } ] }, @@ -44821,26 +48094,25 @@ "type": "integer" }, { - "description": "Cisco ASA 1000v resource ID", + "description": "List by keyword", "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, - "name": "pagesize", + "name": "hostname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the Physical Network ID", @@ -44851,17 +48123,16 @@ "type": "uuid" }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "hostname", + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", "required": false, - "type": "string" + "type": "uuid" } ], "related": "addCiscoAsa1000vResource", "response": [ - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -44870,12 +48141,14 @@ {}, {}, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + {}, {} ] }, @@ -44895,20 +48168,20 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -44924,10 +48197,10 @@ "name": "upgradeRouterTemplate", "params": [ { - "description": "upgrades all routers within the specified cluster", + "description": "upgrades all routers within the specified pod", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -44939,10 +48212,10 @@ "type": "string" }, { - "description": "upgrades all routers within the specified pod", + "description": "upgrades all routers within the specified cluster", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -44973,12 +48246,12 @@ ], "related": "", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -44988,110 +48261,186 @@ ] }, { - "description": "Cancels host maintenance.", - "isasync": true, - "name": "cancelHostMaintenance", + "description": "Lists IPv4 subnets for guest networks.", + "isasync": false, + "name": "listIpv4SubnetsForGuestNetwork", "params": [ { - "description": "the host ID", + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of VPC to which the IPv4 subnet is associated to.", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "length": 255, + "name": "parentid", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of the IPv4 subnet for guest network.", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", - "required": true, + "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", + "required": false, "type": "uuid" - } - ], - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", - "response": [ + }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "The CIDR of the Ipv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "UUID of network to which the IPv4 subnet is associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + } + ], + "related": "createIpv4SubnetForGuestNetwork", + "response": [ + { + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", + "type": "string" + }, + {}, + { + "description": "date when this IPv4 subnet was removed.", + "name": "removed", "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "id of the data center IPv4 subnet", + "name": "parentid", + "type": "string" }, { - "description": "the ID of the host", + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", + "type": "string" + }, + { + "description": "id of the IPv4 subnet for guest network", "name": "id", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", + "params": [ + { + "description": "the host ID", + "length": 255, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "response": [ + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { "description": "CPU Arch of the host", @@ -45099,141 +48448,129 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, - {}, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, { "description": "true if local storage is active, false otherwise", "name": "islocalstorageactive", "type": "boolean" }, - {}, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { "description": "the state of the host", @@ -45241,44 +48578,80 @@ "type": "status" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + {}, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { "description": "the last annotation set on this host by an admin", @@ -45286,14 +48659,46 @@ "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + {}, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { "description": "comma-separated list of explicit host tags for the host", @@ -45301,41 +48706,46 @@ "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -45349,50 +48759,125 @@ "type": "string" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" } ] }, @@ -45401,14 +48886,6 @@ "isasync": false, "name": "listVlanIpRanges", "params": [ - { - "description": "the Pod ID of the VLAN IP range", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, { "description": "project who will own the VLAN", "length": 255, @@ -45418,11 +48895,12 @@ "type": "uuid" }, { - "description": "", + "description": "the ID of the VLAN IP range", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -45431,6 +48909,13 @@ "required": false, "type": "string" }, + { + "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -45447,105 +48932,89 @@ "type": "uuid" }, { - "description": "the ID of the VLAN IP range", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "id", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "physical network id of the VLAN IP range", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "physical network id of the VLAN IP range", + "description": "network id of the VLAN IP range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "the Pod ID of the VLAN IP range", "length": 255, - "name": "vlan", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "network id of the VLAN IP range", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "forvirtualnetwork", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - }, { "description": "the start ip of the VLAN IP range", "name": "startip", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, - {}, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -45554,43 +49023,45 @@ "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, + {}, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { @@ -45599,8 +49070,8 @@ "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { @@ -45609,40 +49080,54 @@ "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, - {}, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" + }, + { + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -45652,26 +49137,25 @@ "name": "updateZone", "params": [ { - "description": "sort key of the zone, integer", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "sortkey", + "name": "internaldns2", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "guestcidraddress", + "name": "dhcpprovider", "required": false, "type": "string" }, { - "description": "the ID of the Zone", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "allocationstate", + "required": false, + "type": "string" }, { "description": "the second DNS for the Zone", @@ -45681,51 +49165,44 @@ "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "internaldns1", + "name": "name", "required": false, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "dns1", + "name": "ip6dns2", "required": false, "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "the second internal DNS for the Zone", + "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "internaldns2", + "name": "domain", "required": false, "type": "string" }, { - "description": "the name of the Zone", + "description": "the dns search order list", "length": 255, - "name": "name", + "name": "dnssearchorder", "required": false, - "type": "string" + "type": "list" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "ip6dns2", + "name": "localstorageenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "domain", + "name": "guestcidraddress", "required": false, "type": "string" }, @@ -45737,18 +49214,26 @@ "type": "map" }, { - "description": "the dhcp Provider for the Zone", + "description": "sort key of the zone, integer", "length": 255, - "name": "dhcpprovider", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the ID of the Zone", "length": 255, - "name": "allocationstate", + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "updates a private zone to public if set, but not vice-versa", + "length": 255, + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the first DNS for IPv6 network in the Zone", @@ -45758,94 +49243,187 @@ "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the first DNS for the Zone", "length": 255, - "name": "localstorageenabled", + "name": "dns1", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the dns search order list", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "dnssearchorder", + "name": "internaldns1", "required": false, - "type": "list" + "type": "string" } ], "related": "createZone,listZones,listZones", "response": [ + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, { "description": "Network domain name for the networks in the zone", "name": "domain", "type": "string" }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + }, { "description": "the UUID of the containing domain, null for public zones", "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", + "type": "boolean" }, { - "description": "Zone name", - "name": "name", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, + {}, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the capacity name", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -45854,8 +49432,18 @@ "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -45863,218 +49451,135 @@ "name": "capacitytotal", "type": "long" }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, { "description": "the Pod name", "name": "podname", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" } ], "type": "list" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" - }, - { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, - {}, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, - {}, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, { - "description": "Zone id", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, - { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Zone description", - "name": "description", - "type": "string" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, { "description": "true, if zone contains clusters and hosts from different CPU architectures", "name": "ismultiarch", "type": "boolean" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" + "description": "Zone name", + "name": "name", + "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" - } + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + {} ] }, { @@ -46083,41 +49588,41 @@ "name": "extractVolume", "params": [ { - "description": "the ID of the zone where the volume is located", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "mode", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the volume", + "description": "the ID of the zone where the volume is located", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, - { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, - "type": "string" - }, { "description": "the url to which the volume would be extracted", "length": 2048, "name": "url", "required": false, "type": "string" + }, + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" } ], "related": "extractIso,extractSnapshot,extractTemplate,downloadImageStoreObject", "response": [ { - "description": "type of the storage", - "name": "storagetype", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { @@ -46126,50 +49631,45 @@ "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, + {}, { - "description": "the name of the extracted object", - "name": "name", + "description": "", + "name": "resultstring", "type": "string" }, + {}, { "description": "the time and date the object was created", "name": "created", "type": "date" }, - { - "description": "the state of the extracted object", - "name": "state", - "type": "string" - }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { @@ -46178,13 +49678,18 @@ "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { @@ -46193,168 +49698,88 @@ "type": "integer" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the status of the extraction", + "name": "status", "type": "string" } ] }, { - "description": "Lists IPv4 subnets for guest networks.", - "isasync": false, - "name": "listIpv4SubnetsForGuestNetwork", + "description": "Releases an existing dedicated IPv4 subnet for a zone.", + "isasync": true, + "name": "releaseIpv4SubnetForZone", "params": [ { - "description": "UUID of the IPv4 subnet for guest network.", + "description": "Id of the guest network IPv4 subnet", "length": 255, "name": "id", - "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", - "required": false, + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": true, "type": "uuid" + } + ], + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "The CIDR of the Ipv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" }, { - "description": "UUID of VPC to which the IPv4 subnet is associated to.", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "UUID of network to which the IPv4 subnet is associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", - "length": 255, - "name": "parentid", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": false, - "type": "uuid" - } - ], - "related": "createIpv4SubnetForGuestNetwork", - "response": [ - { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" - }, - { - "description": "id of zone to which the IPv4 subnet belongs to.", + "description": "name of zone to which the IPv4 subnet belongs to.", "name": "zonename", "type": "string" }, { - "description": "id of the data center IPv4 subnet", - "name": "parentid", - "type": "string" - }, - {}, - { - "description": "subnet of the IPv4 network", - "name": "subnet", - "type": "string" - }, - { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", - "type": "string" - }, - { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, - { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" - }, - {}, { "description": "date when this IPv4 subnet was created.", "name": "created", "type": "date" }, + {}, { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "id of the IPv4 subnet for guest network", - "name": "id", - "type": "string" - }, - { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", - "type": "string" - }, - { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" } ], @@ -46366,12 +49791,11 @@ "name": "listProjectAccounts", "params": [ { - "description": "list invitation by user ID", + "description": "List by keyword", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -46380,13 +49804,6 @@ "required": false, "type": "integer" }, - { - "description": "list accounts of the project by role", - "length": 255, - "name": "role", - "required": false, - "type": "string" - }, { "description": "list accounts of the project by project role id", "length": 255, @@ -46396,11 +49813,20 @@ "type": "uuid" }, { - "description": "list accounts of the project by account name", + "description": "ID of the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" + }, + { + "description": "list invitation by user ID", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -46410,17 +49836,16 @@ "type": "integer" }, { - "description": "ID of the project", + "description": "list accounts of the project by account name", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "List by keyword", + "description": "list accounts of the project by role", "length": 255, - "name": "keyword", + "name": "role", "required": false, "type": "string" } @@ -46428,19 +49853,19 @@ "related": "activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the name of the project", + "name": "name", + "type": "string" }, { "description": "the total number of vpcs the project can own", @@ -46448,19 +49873,19 @@ "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, { "description": "the total number of networks owned by project", @@ -46468,130 +49893,129 @@ "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the state of the project", - "name": "state", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, { "description": "the total number of virtual machines running for this project", "name": "vmrunning", "type": "integer" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the state of the project", + "name": "state", "type": "string" }, - {}, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { "description": "the total volume being used by this project", @@ -46599,47 +50023,67 @@ "type": "long" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -46648,8 +50092,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -46658,162 +50102,137 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { "description": "the total number of public ip addresses available for this project to acquire", "name": "ipavailable", "type": "string" }, - {}, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - } - ], - "since": "3.0.0" - }, - { - "description": "Releases an existing dedicated IPv4 subnet for a zone.", - "isasync": true, - "name": "releaseIpv4SubnetForZone", - "params": [ - { - "description": "Id of the guest network IPv4 subnet", - "length": 255, - "name": "id", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", - "required": true, - "type": "uuid" - } - ], - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "response": [ { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, - {}, - {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the account of the IPv4 subnet", - "name": "account", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" } ], - "since": "4.20.0" + "since": "3.0.0" }, { "description": "Updates an existing autoscale policy.", @@ -46821,19 +50240,19 @@ "name": "updateAutoScalePolicy", "params": [ { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "conditionids", - "related": "listConditions", + "name": "duration", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "the name of the autoscale policy", "length": 255, - "name": "duration", + "name": "name", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { "description": "the ID of the autoscale policy", @@ -46844,42 +50263,31 @@ "type": "uuid" }, { - "description": "the name of the autoscale policy", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "name", + "name": "quiettime", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "quiettime", + "name": "conditionids", + "related": "listConditions", "required": false, - "type": "integer" + "type": "list" } ], "related": "listAutoScalePolicies", "response": [ { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - }, - { - "description": "name of the autoscale policy", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, - {}, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -46887,11 +50295,6 @@ "name": "id", "type": "string" }, - { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" - }, { "description": "the account owning the autoscale policy", "name": "account", @@ -46899,20 +50302,25 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" + }, + { + "description": "name of the autoscale policy", + "name": "name", + "type": "string" + }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "name": "action", @@ -46923,58 +50331,158 @@ "name": "quiettime", "type": "integer" }, + {}, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" } ] }, { - "description": "Creates a disk offering.", - "isasync": false, - "name": "createDiskOffering", + "description": "Creates a IPv4 subnet for a zone.", + "isasync": true, + "name": "createIpv4SubnetForZone", "params": [ { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "project who will own the IPv4 subnet", "length": 255, - "name": "displayoffering", + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "length (in seconds) of the burst", + "description": "The CIDR of the IPv4 subnet.", "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "type": "long" + "name": "subnet", + "required": true, + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "account who will own the IPv4 subnet", "length": 255, - "name": "iopswriteratemax", + "name": "account", "required": false, - "type": "long" + "type": "string" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "UUID of the zone which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "domain ID of the account owning the IPv4 subnet", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "list" + "type": "uuid" + } + ], + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" + }, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Creates a disk offering.", + "isasync": false, + "name": "createDiskOffering", + "params": [ + { + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "storagetype", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" }, { "description": "Volumes using this offering should be encrypted", @@ -46985,38 +50493,46 @@ "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "provisioningtype", + "name": "cachemode", "required": false, + "since": "4.14", "type": "string" }, { - "description": "burst requests read rate of the disk offering", + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", "length": 255, - "name": "iopsreadratemax", + "name": "disksizestrictness", "required": false, - "type": "long" + "since": "4.17", + "type": "boolean" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "length (in seconds) of the burst", "length": 255, - "name": "storagetype", + "name": "iopswriteratemaxlength", "required": false, + "type": "long" + }, + { + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "disksizestrictness", + "name": "provisioningtype", "required": false, - "since": "4.17", - "type": "boolean" + "type": "string" }, { - "description": "min iops of the disk offering", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", "length": 255, - "name": "miniops", + "name": "disksize", "required": false, "type": "long" }, @@ -47029,112 +50545,110 @@ "type": "map" }, { - "description": "name of the disk offering", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" }, { - "description": "max iops of the disk offering", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "maxiops", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "long" + "type": "list" }, { - "description": "burst bytes write rate of the disk offering", + "description": "whether disk offering size is custom or not", "length": 255, - "name": "byteswriteratemax", + "name": "customized", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "io requests read rate of the disk offering", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "iopsreadrate", + "name": "iopsreadratemax", "required": false, "type": "long" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "disksize", + "name": "displayoffering", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "length (in seconds) of the burst", "length": 255, - "name": "cachemode", + "name": "iopsreadratemaxlength", "required": false, - "since": "4.14", - "type": "string" + "type": "long" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "byteswriteratemax", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", "required": false, - "type": "string" + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", + "description": "max iops of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "iopswriteratemax", "required": false, "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "bytesreadratemax", "required": false, "type": "long" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "iopswriterate", "required": false, - "since": "4.13", - "type": "list" + "type": "long" }, { - "description": "whether disk offering size is custom or not", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "customized", + "name": "iopsreadrate", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "bytesreadrate", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "byteswriterate", "required": false, "type": "long" }, @@ -47155,14 +50669,30 @@ { "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriteratemaxlength", + "name": "byteswriteratemaxlength", "required": false, "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "bytesreadrate", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "length": 255, + "name": "hypervisorsnapshotreserve", + "required": false, + "type": "integer" + }, + { + "description": "min iops of the disk offering", + "length": 255, + "name": "miniops", "required": false, "type": "long" } @@ -47170,35 +50700,29 @@ "related": "", "response": [ { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, - {}, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" - }, - { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", @@ -47206,41 +50730,20 @@ "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" - }, - { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, { "description": "bytes write rate of the disk offering", "name": "diskBytesWriteRate", @@ -47252,69 +50755,51 @@ "type": "boolean" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "type": "string" - }, - { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, - { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" - }, { "description": "Whether disks using this offering will be encrypted on primary storage", "name": "encrypt", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "name": "diskBytesReadRateMaxLength", "type": "long" }, + {}, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, + {}, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, { "description": "additional key/value details tied with this disk offering", @@ -47322,167 +50807,101 @@ "type": "map" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" + }, + { + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", "type": "boolean" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "state of the disk offering", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" + }, + { + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "name": "hypervisorsnapshotreserve", "type": "integer" - } - ] - }, - { - "description": "Creates a IPv4 subnet for a zone.", - "isasync": true, - "name": "createIpv4SubnetForZone", - "params": [ - { - "description": "The CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": true, - "type": "string" - }, - { - "description": "account who will own the IPv4 subnet", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "project who will own the IPv4 subnet", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "domain ID of the account owning the IPv4 subnet", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "UUID of the zone which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "response": [ - { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the domain name of the IPv4 subnet", - "name": "domain", - "type": "string" - }, - { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", - "type": "string" - }, - { - "description": "guest IPv4 subnet", - "name": "subnet", - "type": "string" - }, - { - "description": "the project name of the IPv4 subnet", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the account of the IPv4 subnet", - "name": "account", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" } - ], - "since": "4.20.0" + ] }, { "description": "Lists details of network protocols", @@ -47499,37 +50918,37 @@ ], "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the description of the protocol parameter", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", - "name": "index", - "type": "integer" + "description": "the details of the protocol parameter", + "name": "details", + "type": "map" }, {}, + {}, { "description": "the name of the protocol parameter", "name": "name", "type": "string" }, { - "description": "the details of the protocol parameter", - "name": "details", - "type": "map" + "description": "the description of the protocol parameter", + "name": "description", + "type": "string" + }, + { + "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", + "name": "index", + "type": "integer" } ], "since": "4.19.0" @@ -47540,26 +50959,26 @@ "name": "listLBHealthCheckPolicies", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of the load balancer rule", "length": 255, - "name": "pagesize", + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the ID of the health check policy", @@ -47571,53 +50990,26 @@ "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "List by keyword", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" } ], "related": "createLBHealthCheckPolicy", "response": [ { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { @@ -47625,19 +51017,14 @@ "name": "healthcheckpolicy", "response": [ { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" }, { "description": "Number of consecutive health check failures before declaring an instance unhealthy.", @@ -47645,14 +51032,19 @@ "type": "int" }, { - "description": "the state of the policy", - "name": "state", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "Time to wait when receiving a response from the health check", @@ -47660,21 +51052,48 @@ "type": "int" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "the state of the policy", + "name": "state", + "type": "string" } ], "type": "list" }, + {}, + {}, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -47686,12 +51105,20 @@ "name": "migrateVirtualMachineWithVolume", "params": [ { - "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", + "description": "the ID of the virtual machine", "length": 255, - "name": "autoselect", + "name": "virtualmachineid", + "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", + "required": true, + "type": "uuid" + }, + { + "description": "Destination Host ID to migrate VM to.", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "uuid" }, { "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", @@ -47701,584 +51128,445 @@ "type": "map" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "name": "autoselect", "required": false, - "type": "uuid" - }, - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "since": "4.19.0", + "type": "boolean" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, - {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + {}, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the account owning the security group", - "name": "account", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project name of the group", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project id of the group", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the type of the affinity group", + "name": "type", + "type": "string" } ], "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, - {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { "description": "true if vm has delete protection.", @@ -48286,310 +51574,164 @@ "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, + {}, + {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -48598,23 +51740,28 @@ "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -48623,33 +51770,33 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -48658,157 +51805,489 @@ "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { "description": "ID of the VLAN/VNI if available", "name": "vlanid", "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the name of the security group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { "description": "the name of the backup offering of the virtual machine", @@ -48818,154 +52297,284 @@ ] }, { - "description": "Updates a user account", + "description": "Lists GUI themes.", "isasync": false, - "name": "updateUser", + "name": "listGuiThemes", "params": [ { - "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account", + "description": "Whether to list all themes.", "length": 255, - "name": "apikeyaccess", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "The internet Common Name (CN) to be filtered.", + "length": 255, + "name": "commonname", "required": false, - "since": "4.20.1.0", "type": "string" }, { - "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "description": "Whether to list removed themes.", "length": 255, - "name": "mandate2fa", + "name": "showremoved", "required": false, - "since": "4.18.0.0", "type": "boolean" }, { - "description": "email", + "description": "The name of the theme.", "length": 255, - "name": "email", + "name": "name", "required": false, "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "description": "", "length": 255, - "name": "currentpassword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "first name", + "description": "The ID of the account to be filtered.", "length": 255, - "name": "firstname", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "last name", + "description": "", "length": 255, - "name": "lastname", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Whether to only list the default theme.", "length": 255, - "name": "timezone", + "name": "listonlydefaulttheme", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Unique username", + "description": "List by keyword", "length": 255, - "name": "username", + "name": "keyword", "required": false, "type": "string" }, { - "description": "User uuid", + "description": "The ID of the domain to be filtered.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "The theme ID.", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, + "related": "listGuiThemes,createGuiTheme", + "required": false, "type": "uuid" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "Whether to list public themes.", "length": 255, - "name": "userapikey", + "name": "showpublic", "required": false, + "type": "boolean" + } + ], + "related": "createGuiTheme", + "response": [ + { + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", "type": "string" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Description of the GUI theme.", + "name": "description", + "type": "string" + }, + { + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", + "type": "string" + }, + {}, + { + "description": "ID of the custom GUI theme.", + "name": "id", + "type": "string" + }, + { + "description": "Name of the GUI theme.", + "name": "name", + "type": "string" + }, + { + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", + "type": "string" + }, + { + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "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`.", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" + }, + { + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", + "type": "string" + } + ], + "since": "4.21.0.0" + }, + { + "description": "Updates a user account", + "isasync": false, + "name": "updateUser", + "params": [ + { + "description": "last name", "length": 255, - "name": "usersecretkey", + "name": "lastname", "required": false, "type": "string" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "password", + "name": "currentpassword", "required": false, "type": "string" - } - ], - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", - "response": [ + }, { - "description": "the user email address", - "name": "email", + "description": "The API key for the user. Must be specified with userSecretKey", + "length": 255, + "name": "userapikey", + "required": false, "type": "string" }, - {}, { - "description": "the user lastname", - "name": "lastname", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": false, "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account", + "length": 255, + "name": "apikeyaccess", + "required": false, + "since": "4.20.1.0", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "first name", + "length": 255, + "name": "firstname", + "required": false, "type": "string" }, { - "description": "the user ID", + "description": "User uuid", + "length": 255, "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" + }, + { + "description": "Unique username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "email", + "length": 255, + "name": "email", + "required": false, + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "The secret key for the user. Must be specified with userApiKey", + "length": 255, + "name": "usersecretkey", + "required": false, + "type": "string" + }, + { + "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "length": 255, + "name": "mandate2fa", + "required": false, + "since": "4.18.0.0", "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "length": 255, + "name": "password", + "required": false, "type": "string" - }, + } + ], + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "response": [ + {}, { - "description": "the user state", - "name": "state", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -48974,13 +52583,13 @@ "type": "resourceiconresponse" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -48988,20 +52597,25 @@ "name": "isdefault", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user state", + "name": "state", + "type": "string" }, + {}, { "description": "the secret key of the user", "name": "secretkey", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -49015,39 +52629,74 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -49060,33 +52709,33 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -49096,27 +52745,19 @@ "name": "addHost", "params": [ { - "description": "the host URL", + "description": "hypervisor type of the host", "length": 255, - "name": "url", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the Zone ID for the host", + "description": "comma separated list of storage access groups for the host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" }, { "description": "the cluster name for the host", @@ -49125,13 +52766,6 @@ "required": false, "type": "string" }, - { - "description": "Allocation state of this Host for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, { "description": "list of tags to be added to the host", "length": 255, @@ -49140,16 +52774,25 @@ "type": "list" }, { - "description": "hypervisor type of the host", + "description": "the Pod ID for the host", "length": 255, - "name": "hypervisor", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "password", + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "Allocation state of this Host for allocation of new resources", + "length": 255, + "name": "allocationstate", "required": false, "type": "string" }, @@ -49161,144 +52804,113 @@ "required": false, "type": "uuid" }, + { + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, { "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, "name": "username", "required": false, "type": "string" + }, + { + "description": "the host URL", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "length": 255, + "name": "password", + "required": false, + "type": "string" } ], "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, + {}, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { "description": "the amount of the host's CPU currently used", @@ -49306,130 +52918,135 @@ "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, - {}, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, + {}, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { "description": "the Pod name of the host", @@ -49437,130 +53054,229 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the host version", - "name": "version", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" } ] }, @@ -49569,14 +53285,6 @@ "isasync": true, "name": "attachVolume", "params": [ - { - "description": " the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", "length": 255, @@ -49584,6 +53292,14 @@ "required": false, "type": "long" }, + { + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "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", + "required": true, + "type": "uuid" + }, { "description": "the ID of the disk volume", "length": 255, @@ -49596,53 +53312,79 @@ "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, + {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -49651,42 +53393,122 @@ "type": "boolean" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -49695,13 +53517,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -49710,108 +53532,103 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, + {}, { - "description": "the path of the volume", - "name": "path", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -49819,58 +53636,48 @@ "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { @@ -49879,28 +53686,28 @@ "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { @@ -49909,117 +53716,89 @@ "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" + } + ] + }, + { + "description": "Deletes a CNI Configuration", + "isasync": false, + "name": "deleteCniConfiguration", + "params": [ + { + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "listCniConfiguration", + "required": true, + "type": "uuid" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "response": [ { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - } - ] + {} + ], + "since": "4.21.0" }, { "description": "Updates a project", @@ -50027,11 +53806,12 @@ "name": "updateProject", "params": [ { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "description": "id of the project to be modified", "length": 255, - "name": "swapowner", - "required": false, - "type": "boolean" + "name": "id", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { "description": "name of the project", @@ -50041,6 +53821,14 @@ "since": "4.19.0", "type": "string" }, + { + "description": "ID of the user to be promoted/demoted", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, { "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, @@ -50056,89 +53844,147 @@ "type": "string" }, { - "description": "ID of the user to be promoted/demoted", + "description": "new Admin account for the project", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "name": "account", "required": false, - "type": "uuid" - }, - { - "description": "id of the project to be modified", - "length": 255, - "name": "id", - "related": "activateProject,createProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "new Admin account for the project", + "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", "length": 255, - "name": "account", + "name": "swapowner", "required": false, - "type": "string" + "type": "boolean" } ], "related": "activateProject,createProject,suspendProject", "response": [ { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", "type": "list" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total number of backups stored by this project", + "name": "backuptotal", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { @@ -50147,14 +53993,34 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { "description": "the state of the project", @@ -50162,162 +54028,145 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, - {}, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the project", + "name": "id", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" + }, + {}, + { + "description": "the account name of the project's owners", + "name": "owner", "type": "list" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, {}, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { @@ -50326,64 +54175,69 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { "description": "the total number of virtual machines stopped for this project", "name": "vmstopped", "type": "integer" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" } ], "since": "3.0.0" @@ -50394,164 +54248,179 @@ "name": "listLoadBalancers", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the load balancer", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the source IP address of the load balancer", "length": 255, - "name": "pagesize", + "name": "sourceipaddress", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "scheme", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the ID of the load balancer", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "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.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the network ID of the load balancer", + "description": "the network ID of the source IP address", "length": 255, - "name": "networkid", + "name": "sourceipaddressnetworkid", "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the name of the load balancer", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "", "length": 255, - "name": "scheme", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "tags", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "the source IP address of the load balancer", + "description": "the network ID of the load balancer", "length": 255, - "name": "sourceipaddress", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "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.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the network ID of the source IP address", + "description": "the name of the load balancer", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createLoadBalancer", "response": [ { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" }, { "description": "Load Balancer source ip", "name": "sourceipaddress", "type": "string" }, - {}, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -50560,23 +54429,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -50585,54 +54449,33 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" - } - ], - "type": "list" - }, - { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" }, { - "description": "the state of the load balancer rule", - "name": "state", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "list" }, + {}, { "description": "the list of instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, { "description": "the instance ID", "name": "id", @@ -50647,24 +54490,14 @@ "description": "the name of the instance", "name": "name", "type": "string" - }, - { - "description": "the state of the instance", - "name": "state", - "type": "string" } ], "type": "list" }, { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the domain of the Load Balancer", @@ -50672,28 +54505,45 @@ "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + } + ], + "type": "list" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { @@ -50701,10 +54551,14 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the Load Balancer ID", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" } ], @@ -50726,15 +54580,9 @@ ], "related": "getUserKeys", "response": [ - {}, - { - "description": "whether api key access is allowed or not", - "name": "apikeyaccess", - "type": "boolean" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, { @@ -50743,10 +54591,16 @@ "type": "string" }, { - "description": "the api key of the registered user", - "name": "apikey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "whether api key access is allowed or not", + "name": "apikeyaccess", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -50770,15 +54624,14 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -50786,9 +54639,10 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} @@ -50801,13 +54655,20 @@ "name": "listVpnConnections", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "id of vpc", "length": 255, @@ -50826,10 +54687,25 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "id of the vpn connection", "length": 255, @@ -50846,50 +54722,39 @@ "type": "boolean" }, { - "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.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" - }, + } + ], + "related": "createVpnConnection,updateVpnConnection", + "response": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": false, - "type": "uuid" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - } - ], - "related": "createVpnConnection,updateVpnConnection", - "response": [ - { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, + {}, { "description": "is connection for display to the regular user", "name": "fordisplay", @@ -50901,125 +54766,114 @@ "type": "long" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "type": "boolean" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" - }, { "description": "IPsec Preshared-Key of the customer gateway", "name": "ipsecpsk", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" - }, - { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project name", + "name": "project", "type": "string" }, {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the owner", + "name": "account", "type": "string" }, { @@ -51041,13 +54895,6 @@ "required": true, "type": "string" }, - { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -51055,6 +54902,13 @@ "related": "createZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy", @@ -51065,15 +54919,22 @@ "type": "string" }, {}, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -51085,17 +54946,10 @@ "name": "network", "type": "list" }, - {}, { "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -51105,87 +54959,91 @@ "name": "updateCloudToUseObjectStore", "params": [ { - "description": "the name for the image store", + "description": "the image store provider name", "length": 255, - "name": "name", - "required": false, + "name": "provider", + "required": true, "type": "string" }, { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "description": "the URL for the image store", "length": 255, - "name": "details", + "name": "url", "required": false, - "type": "map" + "type": "string" }, { - "description": "the URL for the image store", + "description": "the name for the image store", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" }, { - "description": "the image store provider name", + "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", "length": 255, - "name": "provider", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", "response": [ { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + {}, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the provider name of the image store", "name": "providername", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the Zone ID of the image store", "name": "zoneid", "type": "string" }, - {}, - {}, { - "description": "the ID of the image store", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the protocol of the image store", @@ -51193,18 +55051,14 @@ "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the name of the image store", - "name": "name", + "description": "the ID of the image store", + "name": "id", "type": "string" }, + {}, { - "description": "the url of the image store", - "name": "url", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" } ], @@ -51215,6 +55069,14 @@ "isasync": false, "name": "createASNRange", "params": [ + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, { "description": "the end AS Number", "length": 255, @@ -51228,34 +55090,31 @@ "name": "startasn", "required": true, "type": "long" - }, - { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" } ], "related": "listASNRanges", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Start AS Number", - "name": "startasn", + "description": "Created date", + "name": "created", + "type": "date" + }, + {}, + { + "description": "End AS Number", + "name": "endasn", "type": "long" }, {}, { - "description": "Created date", - "name": "created", - "type": "date" + "description": "Start AS Number", + "name": "startasn", + "type": "long" }, { "description": "ID of the AS Number Range", @@ -51263,19 +55122,14 @@ "type": "string" }, { - "description": "End AS Number", - "name": "endasn", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Zone ID", "name": "zoneid", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.20.0" @@ -51310,35 +55164,31 @@ ], "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", "response": [ - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" }, {}, + {}, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -51346,7 +55196,11 @@ "name": "jobstatus", "type": "integer" }, - {} + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + } ] }, { @@ -51354,18 +55208,10 @@ "isasync": false, "name": "listTungstenFabricNic", "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -51377,38 +55223,41 @@ "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "pagesize", + "name": "nicuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric nic", + "description": "the ID of zone", "length": 255, - "name": "nicuuid", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric nic name", - "name": "name", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, {}, + { + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", + "type": "string" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", @@ -51416,14 +55265,19 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", + "description": "Tungsten-Fabric nic name", + "name": "name", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -51439,13 +55293,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "Id of the CloudStack zone.", "length": 255, @@ -51460,37 +55307,44 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "addVmwareDc", "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "The VMware Datacenter ID", "name": "id", "type": "string" }, - {}, - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" - }, { "description": "The VMware Datacenter name", "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The VMware vCenter name/ip", "name": "vcenter", "type": "string" }, + { + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -51503,6 +55357,13 @@ "isasync": true, "name": "applyTungstenFabricPolicy", "params": [ + { + "description": "the uuid of network", + "length": 255, + "name": "networkuuid", + "required": true, + "type": "string" + }, { "description": "the major sequence of Tungsten-Fabric policy", "length": 255, @@ -51510,6 +55371,13 @@ "required": true, "type": "integer" }, + { + "description": "the minor sequence of Tungsten-Fabric policy", + "length": 255, + "name": "minorsequence", + "required": true, + "type": "integer" + }, { "description": "the ID of zone", "length": 255, @@ -51524,32 +55392,21 @@ "name": "policyuuid", "required": true, "type": "string" - }, - { - "description": "the uuid of network", - "length": 255, - "name": "networkuuid", - "required": true, - "type": "string" - }, - { - "description": "the minor sequence of Tungsten-Fabric policy", - "length": 255, - "name": "minorsequence", - "required": true, - "type": "integer" } ], "related": "createTungstenFabricPolicy,listTungstenFabricPolicy", "response": [ { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, + {}, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -51557,18 +55414,10 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, - {}, - {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { "description": "Tungsten-Fabric provider zone id", @@ -51576,8 +55425,13 @@ "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -51588,34 +55442,33 @@ "name": "listZones", "params": [ { - "description": "flag to display the capacity of the zones", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "showcapacities", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "ids", - "related": "createZone,listZones,listZones", + "name": "showcapacities", "required": false, - "since": "4.19.0", - "type": "list" + "type": "boolean" }, { - "description": "flag to display the resource image for the zones", + "description": "the ID of the zone", "length": 255, - "name": "showicon", + "name": "id", + "related": "createZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "page", + "name": "networktype", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -51625,11 +55478,19 @@ "type": "string" }, { - "description": "the name of the zone", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", "length": 255, - "name": "name", + "name": "available", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { "description": "List zones by resource tags (key/value pairs)", @@ -51647,32 +55508,33 @@ "type": "integer" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "the name of the storage access group", "length": 255, - "name": "available", + "name": "storageaccessgroup", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "the ID of the zone", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "id", + "name": "ids", "related": "createZone,listZones,listZones", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "list" }, { - "description": "the ID of the domain associated with the zone", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "the name of the zone", "length": 255, - "name": "networktype", + "name": "name", "required": false, "type": "string" } @@ -51680,117 +55542,134 @@ "related": "createZone,listZones", "response": [ { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "AS Number Range", + "name": "asnrange", + "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, + {}, { "description": "the dhcp Provider for the Zone", "name": "dhcpprovider", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", "type": "boolean" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + }, + { + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "Zone name", + "name": "name", + "type": "string" + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -51799,13 +55678,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -51814,79 +55693,82 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "Zone id", - "name": "id", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, - {}, { - "description": "Zone description", - "name": "description", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", - "type": "boolean" + "description": "Zone description", + "name": "description", + "type": "string" }, - {}, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Zone id", + "name": "id", + "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { "description": "true, if zone contains clusters and hosts from different CPU architectures", @@ -51894,13 +55776,13 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { @@ -51908,39 +55790,39 @@ "name": "capacity", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { "description": "the Zone name", @@ -51948,13 +55830,18 @@ "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -51962,11 +55849,6 @@ "name": "type", "type": "short" }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the capacity currently in use", "name": "capacityused", @@ -51976,9 +55858,9 @@ "type": "list" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "Zone Token", + "name": "zonetoken", + "type": "string" } ] }, @@ -51994,13 +55876,6 @@ "required": true, "type": "string" }, - { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, { "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", "length": 255, @@ -52008,51 +55883,213 @@ "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", "required": false, "type": "uuid" + }, + { + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" } ], "related": "listQuarantinedIps,updateQuarantinedIp", "response": [ - {}, + { + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" + }, { "description": "ID of the quarantine process.", "name": "id", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" + }, { "description": "End date for the quarantine.", "name": "enddate", "type": "date" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, + {}, + { + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, { "description": "Account ID of the previous public IP address owner.", "name": "previousownerid", "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19" + }, + { + "description": "Create an extension", + "isasync": false, + "name": "createExtension", + "params": [ + { + "description": "State of the extension", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", + "length": 255, + "name": "orchestratorrequirespreparevm", + "required": false, + "type": "boolean" + }, + { + "description": "Type of the extension", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, + { + "description": "Name of the extension", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Relative path for the extension", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "Description of the extension", + "length": 255, + "name": "description", + "required": false, "type": "string" + } + ], + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "response": [ + {}, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "Name of the extension", + "name": "name", "type": "string" }, { - "description": "When the quarantine was removed.", + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, + { + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + } + ], + "type": "list" + }, + { + "description": "Removal timestamp of the extension, if applicable", "name": "removed", "type": "date" }, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + {}, + { + "description": "The details of the extension", + "name": "details", + "type": "map" }, { "description": "the UUID of the latest async job acting on this object", @@ -52060,17 +56097,22 @@ "type": "string" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "The state of the extension", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "Description of the extension", + "name": "description", + "type": "string" } ], - "since": "4.19" + "since": "4.21.0" }, { "description": "Deletes the backup schedule of a VM", @@ -52078,15 +56120,15 @@ "name": "deleteBackupSchedule", "params": [ { - "description": "ID of the VM", + "description": "ID of the VM from which all backup schedules will be deleted.", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": false, "type": "uuid" }, { - "description": "ID of the schedule", + "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.", "length": 255, "name": "id", "related": "listBackupSchedule", @@ -52101,23 +56143,23 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.14.0" }, @@ -52127,12 +56169,11 @@ "name": "listBackupProviderOfferings", "params": [ { - "description": "The zone ID", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -52142,31 +56183,31 @@ "type": "integer" }, { - "description": "", + "description": "The zone ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "importBackupOffering,listBackupOfferings,updateBackupOffering", "response": [ - {}, { - "description": "name for the backup offering", - "name": "name", - "type": "string" + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" }, { - "description": "zone ID", - "name": "zoneid", + "description": "name for the backup offering", + "name": "name", "type": "string" }, { @@ -52175,39 +56216,45 @@ "type": "string" }, { - "description": "description for the backup offering", - "name": "description", + "description": "external ID on the provider side", + "name": "externalid", "type": "string" }, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "ID of the backup offering", + "name": "id", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "ID of the backup offering", - "name": "id", + "description": "provider name", + "name": "provider", "type": "string" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "the date this backup offering was created", + "name": "created", + "type": "date" + }, + { + "description": "zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "description for the backup offering", + "name": "description", "type": "string" } ], @@ -52228,25 +56275,25 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} @@ -52257,13 +56304,6 @@ "isasync": false, "name": "listNetscalerLoadBalancerNetworks", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -52279,6 +56319,13 @@ "required": true, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -52290,213 +56337,87 @@ "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "state of the network", - "name": "state", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" - }, - { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the id of the network", - "name": "id", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" - }, - { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -52505,23 +56426,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -52535,17 +56451,32 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" }, { "description": "the type of the network", @@ -52553,29 +56484,29 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { "description": "true if network offering is ip conserve mode enabled", @@ -52583,28 +56514,23 @@ "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -52613,46 +56539,19 @@ "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - { - "description": "the name of the network", - "name": "name", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { "description": "the list of services", "name": "service", "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, { "description": "the service name", "name": "name", @@ -52663,28 +56562,28 @@ "name": "provider", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "state of the network provider", "name": "state", "type": "string" }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "uuid of the network provider", "name": "id", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -52693,9 +56592,31 @@ "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" @@ -52704,89 +56625,173 @@ "type": "list" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { "description": "AS NUMBER", "name": "asnumber", "type": "long" }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, { "description": "true if users from subdomains can access the domain level network", "name": "subdomainaccess", "type": "boolean" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { @@ -52795,34 +56800,66 @@ "type": "set" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, + {}, + {}, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" } ] }, @@ -52846,13 +56883,11 @@ "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -52862,7 +56897,9 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {}, + {} ] }, { @@ -52878,22 +56915,28 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ + { + "description": "Network isolation method name", + "name": "name", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -52904,12 +56947,6 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "Network isolation method name", - "name": "name", - "type": "string" - }, {} ], "since": "4.2.0" @@ -52931,40 +56968,40 @@ "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { "description": "the HA state of the host", "name": "hastate", "type": "hastate" }, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - {}, - {}, { "description": "the host HA provider", "name": "haprovider", "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "operation status", + "name": "status", "type": "boolean" } ], @@ -52982,6 +57019,13 @@ "required": false, "type": "string" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -53010,22 +57054,21 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "createTungstenFabricFirewallPolicy", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -53033,29 +57076,23 @@ "type": "integer" }, { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "list Tungsten-Fabric firewall rule", "name": "firewallrule", "type": "list" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -53066,11 +57103,12 @@ "name": "importBackupOffering", "params": [ { - "description": "the description of the backup offering", + "description": "The zone ID", "length": 255, - "name": "description", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Whether users are allowed to create adhoc backups and backup schedules", @@ -53080,31 +57118,34 @@ "type": "boolean" }, { - "description": "The backup offering ID (from backup provider side)", + "description": "the name of the backup offering", "length": 255, - "name": "externalid", + "name": "name", "required": true, "type": "string" }, { - "description": "the name of the backup offering", + "description": "the description of the backup offering", "length": 255, - "name": "name", + "name": "description", "required": true, "type": "string" }, { - "description": "The zone ID", + "description": "The backup offering ID (from backup provider side)", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "externalid", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listBackupOfferings,updateBackupOffering", "response": [ - {}, + { + "description": "name for the backup offering", + "name": "name", + "type": "string" + }, { "description": "external ID on the provider side", "name": "externalid", @@ -53116,29 +57157,35 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the backup offering", + "name": "id", "type": "string" }, + {}, { - "description": "name for the backup offering", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "zone ID", + "name": "zoneid", "type": "string" }, + {}, { "description": "the date this backup offering was created", "name": "created", "type": "date" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "zone name", + "name": "zonename", + "type": "string" }, { - "description": "ID of the backup offering", - "name": "id", + "description": "provider name", + "name": "provider", "type": "string" }, { @@ -53147,13 +57194,8 @@ "type": "string" }, { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -53164,6 +57206,13 @@ "isasync": true, "name": "deleteDomain", "params": [ + { + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" + }, { "description": "ID of domain to delete", "length": 255, @@ -53171,37 +57220,30 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" - }, - { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, {} ] }, @@ -53210,6 +57252,13 @@ "isasync": true, "name": "migrateVolume", "params": [ + { + "description": "if the volume should be live migrated when it is attached to a running vm", + "length": 255, + "name": "livemigrate", + "required": false, + "type": "boolean" + }, { "description": "destination storage pool ID to migrate the volume to", "length": 255, @@ -53226,13 +57275,6 @@ "required": true, "type": "uuid" }, - { - "description": "if the volume should be live migrated when it is attached to a running vm", - "length": 255, - "name": "livemigrate", - "required": false, - "type": "boolean" - }, { "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", "length": 255, @@ -53245,145 +57287,64 @@ "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "name of the disk volume", + "name": "name", "type": "string" }, + {}, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -53392,19 +57353,14 @@ "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { "description": "true if the entity/resource has annotations", @@ -53412,28 +57368,28 @@ "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { @@ -53442,19 +57398,19 @@ "type": "date" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -53462,78 +57418,84 @@ "type": "integer" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, + {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { @@ -53541,50 +57503,54 @@ "name": "quiescevm", "type": "boolean" }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, { "description": "the bytes allocated", "name": "virtualsize", "type": "long" }, - {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { @@ -53593,80 +57559,156 @@ "type": "long" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { "description": "the state of the disk volume", "name": "state", "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" } ], "since": "3.0.0" @@ -53694,6 +57736,17 @@ ], "related": "", "response": [ + { + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -53701,9 +57754,9 @@ "type": "string" }, { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "list Tungsten-Fabric firewall policy", @@ -53711,32 +57764,61 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" + } + ] + }, + { + "description": "Deletes an existing Bgp Peer.", + "isasync": true, + "name": "deleteBgpPeer", + "params": [ + { + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {} - ] + ], + "since": "4.20.0" }, { "description": "A command to list events.", @@ -53744,32 +57826,48 @@ "name": "listEvents", "params": [ { - "description": "the duration of the event", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "duration", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "true to list archived events otherwise false", "length": 255, - "name": "pagesize", + "name": "archived", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", + "description": "the ID of the resource associated with the event", "length": 255, - "name": "startid", - "related": "listEvents", + "name": "resourceid", + "required": false, + "since": "4.17.0", + "type": "string" + }, + { + "description": "the event level (INFO, WARN, ERROR)", + "length": 255, + "name": "level", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" }, @@ -53781,19 +57879,18 @@ "type": "string" }, { - "description": "true to list archived events otherwise false", + "description": "", "length": 255, - "name": "archived", + "name": "page", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the time the event was entered", "length": 255, - "name": "isrecursive", + "name": "entrytime", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "the event type (see event types)", @@ -53803,17 +57900,9 @@ "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "the time the event was entered", + "description": "", "length": 255, - "name": "entrytime", + "name": "pagesize", "required": false, "type": "integer" }, @@ -53826,131 +57915,117 @@ "type": "string" }, { - "description": "the ID of the event", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listEvents", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "The state of the events", "length": 255, - "name": "startdate", + "name": "state", "required": false, - "type": "date" + "since": "4.21.0", + "type": "string" }, { - "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.", + "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", "length": 255, - "name": "listall", + "name": "startid", + "related": "listEvents", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "enddate", + "name": "account", "required": false, - "type": "date" + "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "the ID of the event", "length": 255, - "name": "level", + "name": "id", + "related": "listEvents", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "page", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "the ID of the resource associated with the event", + "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.", "length": 255, - "name": "resourceid", + "name": "listall", "required": false, - "since": "4.17.0", - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the duration of the event", "length": 255, - "name": "account", + "name": "duration", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "whether the event is parented", - "name": "parentid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "path of the Domain the account's domain belongs to", - "name": "domainpath", + "description": "the type of the event (see event types)", + "name": "type", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "whether the event has been archived or not", - "name": "archived", - "type": "boolean" - }, - {}, - { - "description": "the name of the resource", - "name": "resourcename", + "description": "the type of the resource", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the event (see event types)", - "name": "type", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, + {}, { "description": "the name of the account's domain", "name": "domain", "type": "string" }, { - "description": "the id of the resource", - "name": "resourceid", - "type": "string" + "description": "the date the event was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the address", - "name": "project", + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" }, { - "description": "a brief description of the event", - "name": "description", + "description": "the id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the Domain the account's domain belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the state of the event", - "name": "state", - "type": "state" + "description": "whether the event has been archived or not", + "name": "archived", + "type": "boolean" }, { "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", @@ -53958,19 +58033,24 @@ "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "description": "a brief description of the event", + "name": "description", "type": "string" }, { - "description": "the date the event was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the account's domain", + "name": "domainid", + "type": "string" }, {}, { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -53979,13 +58059,23 @@ "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the ID of the event", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the resource", + "name": "resourcename", + "type": "string" + }, + { + "description": "the state of the event", + "name": "state", + "type": "state" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" } ] @@ -54006,90 +58096,57 @@ "related": "configureHAForHost,enableHAForHost,disableHAForHost", "response": [ { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the host HA provider", + "name": "haprovider", + "type": "string" }, + {}, { "description": "operation status", "name": "status", "type": "boolean" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the host", "name": "hostid", "type": "string" }, - {}, { "description": "if host HA is enabled for the host", "name": "haenable", "type": "boolean" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" } ], "since": "4.11" }, { - "description": "Deletes an existing Bgp Peer.", + "description": "Creates resource tag(s)", "isasync": true, - "name": "deleteBgpPeer", + "name": "createTags", "params": [ { - "description": "Id of the Bgp Peer", + "description": "type of the resource", "length": 255, - "name": "id", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "name": "resourcetype", "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Creates resource tag(s)", - "isasync": true, - "name": "createTags", - "params": [ { "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, @@ -54097,13 +58154,6 @@ "required": false, "type": "string" }, - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - }, { "description": "list of resources to create the tags for", "length": 255, @@ -54125,22 +58175,22 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {} ], "since": "4.0.0" @@ -54162,32 +58212,32 @@ "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "response": [ { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, { "description": "the physical network service provider id of the element", "name": "nspid", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.2.0" }, @@ -54207,8 +58257,8 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -54222,12 +58272,12 @@ "type": "integer" }, {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -54247,11 +58297,10 @@ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -54262,10 +58311,11 @@ "name": "displaytext", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -54274,20 +58324,6 @@ "isasync": true, "name": "generateAlert", "params": [ - { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, - "type": "string" - }, - { - "description": "Name of the alert", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "Type of the alert", "length": 255, @@ -54310,29 +58346,43 @@ "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" + }, + { + "description": "Name of the alert", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, + "type": "string" } ], "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], @@ -54343,13 +58393,6 @@ "isasync": false, "name": "ldapConfig", "params": [ - { - "description": "Specify the LDAP port if required, default is 389.", - "length": 255, - "name": "port", - "required": false, - "type": "integer" - }, { "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, @@ -54358,9 +58401,9 @@ "type": "string" }, { - "description": "Enter the path to trust certificates store.", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "truststore", + "name": "binddn", "required": false, "type": "string" }, @@ -54372,44 +58415,51 @@ "type": "boolean" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "ssl", + "name": "hostname", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", + "description": "Enter the password.", "length": 255, - "name": "queryfilter", + "name": "bindpass", "required": false, "type": "string" }, { - "description": "Enter the password.", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "bindpass", + "name": "ssl", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory.", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "binddn", + "name": "truststore", "required": false, "type": "string" }, { - "description": "Enter the password for trust store.", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "truststorepass", + "name": "queryfilter", "required": false, "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "hostname", + "name": "port", + "required": false, + "type": "integer" + }, + { + "description": "Enter the password for trust store.", + "length": 255, + "name": "truststorepass", "required": false, "type": "string" } @@ -54417,25 +58467,25 @@ "related": "ldapRemove", "response": [ { - "description": "DN password", - "name": "bindpass", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, + {}, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, - {}, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, { @@ -54444,24 +58494,24 @@ "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "DN password", + "name": "bindpass", + "type": "string" } ], "since": "3.0.0" @@ -54483,23 +58533,25 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + {}, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { - "description": "the name of the Storage Policy", - "name": "name", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { @@ -54507,18 +58559,16 @@ "name": "description", "type": "string" }, - {}, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -54530,7 +58580,7 @@ "description": "the ID of the port forwarding rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } @@ -54542,22 +58592,22 @@ "type": "string" }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -54565,6 +58615,13 @@ "isasync": true, "name": "migrateVPC", "params": [ + { + "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" + }, { "description": "true if previous network migration cmd failed", "length": 255, @@ -54573,25 +58630,18 @@ "type": "boolean" }, { - "description": "vpc offering ID", + "description": "the ID of the vpc", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": true, "type": "uuid" }, { - "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", - "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" - }, - { - "description": "the ID of the vpc", + "description": "vpc offering ID", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", "required": true, "type": "uuid" } @@ -54599,34 +58649,9 @@ "related": "listVPCs,createVPC,listVPCs,updateVPC", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { "description": "the id of the VPC", @@ -54634,199 +58659,81 @@ "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, + {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "The routes for the VPC to ease adding route in upstream router", "name": "ip4routes", "type": "set" }, - {}, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, { - "description": "the project name of the VPC", - "name": "project", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, - {}, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, { "description": "true VPC requires restart", "name": "restartrequired", "type": "boolean" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "the project id of the VPC", - "name": "projectid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, - { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" - }, - { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" - }, { "description": "the list of supported services", "name": "service", @@ -54835,26 +58742,26 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the provider name", "name": "name", "type": "string" }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -54866,26 +58773,21 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "the capability value", - "name": "value", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { "description": "the capability name", @@ -54893,20 +58795,30 @@ "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the capability value", + "name": "value", + "type": "string" } ], "type": "list" - } - ], - "type": "list" - }, + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { "description": "the first IPv6 DNS for the VPC", @@ -54914,19 +58826,157 @@ "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" } ], "since": "4.11.0" @@ -54946,28 +58996,28 @@ } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -54998,55 +59048,55 @@ "type": "integer" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, - {}, { "description": "True if the annotation is available for admins only", "name": "adminsonly", "type": "boolean" }, - {}, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, + {}, { "description": "the removal timestamp for this annotation", "name": "removed", "type": "date" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + {}, + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -55062,14 +59112,6 @@ "isasync": false, "name": "updateConfiguration", "params": [ - { - "description": "the ID of the Domain to update the parameter value for corresponding domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, @@ -55079,25 +59121,25 @@ "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the name of the configuration", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the value of the configuration", - "length": 4096, - "name": "value", + "description": "the ID of the Domain to update the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, @@ -55109,13 +59151,6 @@ "required": false, "type": "uuid" }, - { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, @@ -55123,33 +59158,48 @@ "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" + }, + { + "description": "the ID of the Zone to update the parameter value for corresponding zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the value of the configuration", + "length": 4096, + "name": "value", + "required": false, + "type": "string" } ], "related": "listConfigurations", "response": [ { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { @@ -55158,62 +59208,62 @@ "type": "string" }, { - "description": "the description of the configuration", - "name": "description", - "type": "string" + "description": "the value of the configuration", + "name": "id", + "type": "long" }, + {}, { "description": "true if the configuration is dynamic", "name": "isdynamic", "type": "boolean" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, - {}, { - "description": "the category of the configuration", - "name": "category", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the component of the configuration", + "name": "component", "type": "string" }, + {}, { - "description": "the value of the configuration", - "name": "id", - "type": "long" - }, - {} + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" + } ] }, { @@ -55240,19 +59290,13 @@ "related": "enableHAForHost,disableHAForHost", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { @@ -55260,22 +59304,28 @@ "name": "status", "type": "boolean" }, - { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" - }, + {}, { "description": "if host HA is enabled for the host", "name": "haenable", "type": "boolean" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the HA state of the host", "name": "hastate", "type": "hastate" - } + }, + {} ], "since": "4.11" }, @@ -55285,55 +59335,55 @@ "name": "listVolumesUsageHistory", "params": [ { - "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "name", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "", + "description": "the IDs of the volumes, mutually exclusive with id.", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "type": "integer" + "type": "list" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" }, { - "description": "List by keyword", + "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "the ID of the volume.", "length": 255, - "name": "enddate", + "name": "id", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id.", + "description": "List by keyword", "length": 255, - "name": "ids", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the volume.", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "id", - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { "description": "", @@ -55345,6 +59395,16 @@ ], "related": "", "response": [ + { + "description": "the list of VM stats", + "name": "stats", + "type": "list" + }, + { + "description": "the ID of the volume", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -55356,22 +59416,12 @@ "type": "string" }, {}, - { - "description": "the ID of the volume", - "name": "id", - "type": "string" - }, - { - "description": "the list of VM stats", - "name": "stats", - "type": "list" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.18.0" }, @@ -55380,6 +59430,14 @@ "isasync": false, "name": "dedicatePublicIpRange", "params": [ + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" + }, { "description": "domain ID of the account owning a VLAN", "length": 255, @@ -55402,158 +59460,150 @@ "name": "account", "required": false, "type": "string" - }, - { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": false, - "type": "uuid" } ], "related": "createVlanIpRange,updateVlanIpRange", "response": [ { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, - {}, - { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the project id of the vlan range", - "name": "projectid", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, - {}, { "description": "the Pod ID for the VLAN IP range", "name": "podid", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + }, + { + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" } ] @@ -55575,25 +59625,25 @@ "response": [ {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], "since": "4.19.0" @@ -55603,14 +59653,6 @@ "isasync": false, "name": "createProjectRolePermission", "params": [ - { - "description": "ID of project where project role permission is to be created", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": true, - "type": "uuid" - }, { "description": "The rule permission, allow or deny. Default: deny.", "length": 255, @@ -55625,6 +59667,14 @@ "required": true, "type": "string" }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" + }, { "description": "The description of the role permission", "length": 255, @@ -55633,61 +59683,61 @@ "type": "string" }, { - "description": "ID of the project role", + "description": "ID of project where project role permission is to be created", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": true, "type": "uuid" } ], "related": "listProjectRolePermissions", "response": [ + { + "description": "the ID of the project", + "name": "projectid", + "type": "string" + }, { "description": "the ID of the project role permission", "name": "id", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", - "type": "string" - }, - {}, - { - "description": "the ID of the project", - "name": "projectid", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" } ], @@ -55698,56 +59748,56 @@ "isasync": false, "name": "createConsoleEndpoint", "params": [ - { - "description": "ID of the VM", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, { "description": "(optional) extra security token, valid when the extra validation is enabled", "length": 255, "name": "token", "required": false, "type": "string" + }, + { + "description": "ID of the VM", + "length": 255, + "name": "virtualmachineid", + "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", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "true if the console endpoint is generated properly", - "name": "success", - "type": "boolean" - }, { - "description": "details in case of an error", - "name": "details", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the console websocket options", - "name": "websocket", - "type": "consoleendpointwebsocketresponse" + "description": "the console url", + "name": "url", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the console websocket options", + "name": "websocket", + "type": "consoleendpointwebsocketresponse" }, { - "description": "the console url", - "name": "url", + "description": "details in case of an error", + "name": "details", "type": "string" - } + }, + { + "description": "true if the console endpoint is generated properly", + "name": "success", + "type": "boolean" + }, + {} ], "since": "4.18.0" }, @@ -55756,6 +59806,14 @@ "isasync": false, "name": "updateProjectRolePermission", "params": [ + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" + }, { "description": "Rule permission, can be: allow or deny", "length": 255, @@ -55764,20 +59822,20 @@ "type": "string" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Project Role permission rule id", "length": 255, - "name": "ruleorder", + "name": "projectrolepermissionid", "related": "listProjectRolePermissions", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "Project Role permission rule id", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "projectrolepermissionid", + "name": "ruleorder", "related": "listProjectRolePermissions", "required": false, - "type": "uuid" + "type": "list" }, { "description": "ID of project where project role permission is to be updated", @@ -55786,34 +59844,26 @@ "related": "activateProject,createProject,suspendProject", "required": true, "type": "uuid" - }, - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": true, - "type": "uuid" } ], "response": [ - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -55827,6 +59877,14 @@ "isasync": true, "name": "addUserToProject", "params": [ + { + "description": "ID of the project to add the user to", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" + }, { "description": "Project role type to be assigned to the user - Admin/Regular", "length": 255, @@ -55834,6 +59892,13 @@ "required": false, "type": "string" }, + { + "description": "email ID of user to which invitation to the project is going to be sent", + "length": 255, + "name": "email", + "required": false, + "type": "string" + }, { "description": "ID of the project role", "length": 255, @@ -55848,21 +59913,6 @@ "name": "username", "required": true, "type": "string" - }, - { - "description": "ID of the project to add the user to", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": true, - "type": "uuid" - }, - { - "description": "email ID of user to which invitation to the project is going to be sent", - "length": 255, - "name": "email", - "required": false, - "type": "string" } ], "response": [ @@ -55906,7 +59956,6 @@ } ], "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -55917,17 +59966,18 @@ "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.11" }, @@ -55954,27 +60004,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { @@ -55986,144 +60036,78 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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": [ { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, + {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { "description": "list of variables and values for the variables declared in userdata", @@ -56131,159 +60115,566 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, + {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" + }, { "description": "true if the password rest feature is enabled, false otherwise", "name": "passwordenabled", "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, - {}, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, { "description": "State of the Service from LB rule", "name": "servicestate", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -56292,98 +60683,151 @@ "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, - {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, { "description": "NICs of the VNF appliance", "name": "vnfnics", "type": "list" }, - {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -56397,94 +60841,94 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, { "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -56493,18 +60937,18 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -56513,51 +60957,73 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -56566,45 +61032,23 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { "description": "account owning the security group rule", "name": "account", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -56612,8 +61056,8 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -56622,33 +61066,33 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -56657,476 +61101,142 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" + } + ] + }, + { + "description": "Resets network permissions.", + "isasync": false, + "name": "resetNetworkPermissions", + "params": [ + { + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } - ] - }, - { - "description": "Resets network permissions.", - "isasync": false, - "name": "resetNetworkPermissions", - "params": [ - { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.17.0" @@ -57137,18 +61247,11 @@ "name": "updateBgpPeer", "params": [ { - "description": "The AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": false, - "type": "long" - }, - { - "description": "The password of the Bgp Peer.", + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", "length": 255, - "name": "password", + "name": "cleanupdetails", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Id of the Bgp Peer", @@ -57158,6 +61261,20 @@ "required": true, "type": "uuid" }, + { + "description": "The AS number of the Bgp Peer.", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" + }, + { + "description": "The IPv4 address of the Bgp Peer.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, { "description": "BGP peer details in key/value pairs.", "length": 255, @@ -57173,50 +61290,33 @@ "type": "string" }, { - "description": "The IPv4 address of the Bgp Peer.", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "ipaddress", + "name": "password", "required": false, "type": "string" - }, - { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" } ], "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { @@ -57224,29 +61324,30 @@ "name": "ip6address", "type": "string" }, + {}, { - "description": "password of bgp peer", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { @@ -57256,16 +61357,25 @@ }, {}, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, - {}, { "description": "the account of the bgp peer", "name": "account", @@ -57283,7 +61393,7 @@ "description": "the ID of lb rule", "length": 255, "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,createRoutingFirewallRule,listRoutingFirewallRules", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": true, "type": "uuid" }, @@ -57295,25 +61405,18 @@ "type": "integer" }, { - "description": "loadbalancer health monitor http method", - "length": 255, - "name": "httpmethodtype", - "required": false, - "type": "string" - }, - { - "description": "loadbalancer health monitor url path", + "description": "loadbalancer health monitor expected code", "length": 255, - "name": "urlpath", + "name": "expectedcode", "required": false, "type": "string" }, { - "description": "loadbalancer health monitor expected code", + "description": "loadbalancer health monitor interval", "length": 255, - "name": "expectedcode", - "required": false, - "type": "string" + "name": "interval", + "required": true, + "type": "integer" }, { "description": "loadbalancer health monitor type", @@ -57330,34 +61433,45 @@ "type": "integer" }, { - "description": "loadbalancer health monitor interval", + "description": "loadbalancer health monitor url path", "length": 255, - "name": "interval", - "required": true, - "type": "integer" + "name": "urlpath", + "required": false, + "type": "string" + }, + { + "description": "loadbalancer health monitor http method", + "length": 255, + "name": "httpmethodtype", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the health monitor url path", - "name": "urlpath", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" + "description": "the health monitor type", + "name": "type", + "type": "string" }, { - "description": "the health monitor UUID", - "name": "uuid", + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { @@ -57365,11 +61479,7 @@ "name": "timeout", "type": "int" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -57380,36 +61490,36 @@ "name": "interval", "type": "int" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the health monitor http method", - "name": "httpmethod", - "type": "string" + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, - {}, { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { - "description": "the health monitor type", - "name": "type", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" + "description": "the health monitor ID", + "name": "id", + "type": "long" } ] }, @@ -57434,6 +61544,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -57448,8 +61559,7 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ] }, { @@ -57472,6 +61582,13 @@ "required": false, "type": "boolean" }, + { + "description": "list invitations for specified account; this parameter has to be specified with domainId", + "length": 255, + "name": "token", + "required": false, + "type": "string" + }, { "description": "account that is joining the project", "length": 255, @@ -57486,37 +61603,30 @@ "related": "activateProject,createProject,suspendProject", "required": true, "type": "uuid" - }, - { - "description": "list invitations for specified account; this parameter has to be specified with domainId", - "length": 255, - "name": "token", - "required": false, - "type": "string" } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], "since": "3.0.0" @@ -57538,176 +61648,178 @@ "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "response": [ { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, + {}, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" }, + {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "name of the disk volume", + "name": "volumename", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "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", + "name": "state", + "type": "state" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { "description": "the current status of the latest async job acting on this object", @@ -57715,18 +61827,18 @@ "type": "integer" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "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", - "name": "state", - "type": "state" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { @@ -57735,35 +61847,38 @@ "type": "boolean" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", "type": "long" }, - {}, { - "description": "ID of the snapshot", - "name": "id", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, - {}, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" } ] @@ -57798,16 +61913,10 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -57815,10 +61924,16 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.18.0" }, @@ -57835,16 +61950,16 @@ "type": "integer" }, { - "description": "List Region by region name.", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "List Region by region name.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -57856,29 +61971,29 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addRegion,updateRegion", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, + {}, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -57886,6 +62001,12 @@ "name": "name", "type": "string" }, + { + "description": "the ID of the region", + "name": "id", + "type": "integer" + }, + {}, { "description": "true if GSLB service is enabled in the region, false otherwise", "name": "gslbserviceenabled", @@ -57895,13 +62016,7 @@ "description": "true if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", "type": "boolean" - }, - { - "description": "the ID of the region", - "name": "id", - "type": "integer" - }, - {} + } ] }, { @@ -57909,14 +62024,6 @@ "isasync": true, "name": "migrateSystemVm", "params": [ - { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", - "length": 255, - "name": "autoselect", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, { "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, @@ -57934,6 +62041,14 @@ "required": false, "type": "uuid" }, + { + "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "length": 255, + "name": "autoselect", + "required": false, + "since": "4.16.0", + "type": "boolean" + }, { "description": "the ID of the virtual machine", "length": 255, @@ -57946,116 +62061,121 @@ "related": "startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, + {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, + {}, { "description": "the name of the service offering of the system virtual machine.", "name": "serviceofferingname", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { "description": "the systemvm agent version", @@ -58063,19 +62183,19 @@ "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "CPU arch of the system VM", + "name": "arch", + "type": "string" }, { "description": "the state of the system VM", @@ -58083,14 +62203,14 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the link local netmask for the system vm", @@ -58098,38 +62218,33 @@ "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", + "description": "the date and time the system VM was created", + "name": "created", "type": "date" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { @@ -58138,28 +62253,18 @@ "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" } ] @@ -58170,41 +62275,34 @@ "name": "listCounters", "params": [ { - "description": "ID of the Counter.", + "description": "Network provider of the counter.", "length": 255, - "name": "id", - "related": "createCounter,listCounters", + "name": "provider", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "Source of the counter.", - "length": 255, - "name": "source", - "required": false, - "type": "string" - }, - { - "description": "Network provider of the counter.", + "description": "", "length": 255, - "name": "provider", + "name": "pagesize", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "", + "description": "ID of the Counter.", "length": 255, - "name": "page", + "name": "id", + "related": "createCounter,listCounters", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -58219,39 +62317,41 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "Source of the counter.", + "length": 255, + "name": "source", + "required": false, + "type": "string" } ], "related": "createCounter", "response": [ { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, - {}, { "description": "the id of the Counter", "name": "id", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Name of the counter.", "name": "name", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, + {}, { - "description": "Provider of the counter.", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -58260,6 +62360,11 @@ "name": "source", "type": "string" }, + { + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -58272,13 +62377,6 @@ "isasync": true, "name": "configureInternalLoadBalancerElement", "params": [ - { - "description": "Enables/Disables the Internal Load Balancer element", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the internal lb provider", "length": 255, @@ -58286,37 +62384,44 @@ "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "required": true, "type": "uuid" + }, + { + "description": "Enables/Disables the Internal Load Balancer element", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "listInternalLoadBalancerElements", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" - }, - {}, { "description": "the id of the internal load balancer element", "name": "id", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the physical network service provider id of the element", "name": "nspid", "type": "string" - } + }, + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, + {}, + {} ], "since": "4.2.0" }, @@ -58326,9 +62431,9 @@ "name": "removeTungstenFabricTag", "params": [ { - "description": "the uuid of networks", + "description": "the uuid of nics", "length": 255, - "name": "networkuuid", + "name": "nicuuid", "required": false, "type": "list" }, @@ -58339,21 +62444,6 @@ "required": false, "type": "string" }, - { - "description": "the uuid of nics", - "length": 255, - "name": "nicuuid", - "required": false, - "type": "list" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, { "description": "the uuid of Tungsten-Fabric tag", "length": 255, @@ -58361,6 +62451,13 @@ "required": true, "type": "string" }, + { + "description": "the uuid of networks", + "length": 255, + "name": "networkuuid", + "required": false, + "type": "list" + }, { "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, @@ -58374,25 +62471,48 @@ "name": "vmuuid", "required": false, "type": "list" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" } ], "related": "createTungstenFabricTag,listTungstenFabricTag,applyTungstenFabricTag", "response": [ - {}, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + {}, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -58400,35 +62520,20 @@ "type": "integer" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "list Tungsten-Fabric vm", + "name": "vm", "type": "list" }, + {}, { "description": "list Tungsten-Fabric nic", "name": "nic", "type": "list" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric network", + "name": "network", "type": "list" - }, - { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" } ] }, @@ -58440,23 +62545,24 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list network offerings by enabled state", + "description": "list virtual router elements by id", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list network offerings by enabled state", "length": 255, - "name": "page", + "name": "enabled", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list virtual router elements by network service provider id", @@ -58467,43 +62573,37 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list virtual router elements by id", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "configureVirtualRouterElement", "response": [ - { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, { "description": "the domain associated with the provider", "name": "domain", @@ -58515,29 +62615,34 @@ "type": "integer" }, {}, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, { "description": "the domain ID associated with the provider", "name": "domainid", "type": "string" }, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "path of the domain to which the provider belongs", "name": "domainpath", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the project name of the address", + "name": "project", "type": "string" }, {} @@ -58558,30 +62663,70 @@ } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Delete the custom action", + "isasync": false, + "name": "deleteCustomAction", + "params": [ + { + "description": "uuid of the custom action", + "length": 255, + "name": "id", + "related": "addCustomAction,listCustomActions", + "required": false, + "type": "uuid" + } + ], + "response": [ {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], - "since": "4.20.0" + "since": "4.21.0" }, { "description": "Creates a routing firewall rule in the given network in ROUTED mode", @@ -58589,46 +62734,46 @@ "name": "createRoutingFirewallRule", "params": [ { - "description": "the starting port of firewall rule", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "error code for this ICMP message", "length": 255, - "name": "cidrlist", + "name": "icmpcode", "required": false, - "type": "list" + "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ending port of firewall rule", "length": 255, - "name": "fordisplay", + "name": "endport", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "type of the ICMP message being sent", "length": 255, - "name": "traffictype", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "error code for this ICMP message", + "description": "the starting port of firewall rule", "length": 255, - "name": "icmpcode", + "name": "startport", "required": false, "type": "integer" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "type": "boolean" }, { "description": "The network of the VM the firewall rule will be created for", @@ -58639,82 +62784,46 @@ "type": "uuid" }, { - "description": "the ending port of firewall rule", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "type of the ICMP message being sent", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmptype", + "name": "destcidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "destcidrlist", + "name": "traffictype", "required": false, - "type": "list" + "type": "string" } ], - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "response": [ - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - {}, - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -58723,8 +62832,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -58733,57 +62842,72 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "list" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, - {}, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { @@ -58792,30 +62916,51 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the public ip address id for the port forwarding rule", "name": "ipaddressid", "type": "string" }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, { "description": "the public ip address for the port forwarding rule", "name": "ipaddress", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { "description": "the id of the guest network the port forwarding rule belongs to", "name": "networkid", "type": "string" - } + }, + {} ], "since": "4.20.0" }, @@ -58824,6 +62969,13 @@ "isasync": false, "name": "linkAccountToLdap", "params": [ + { + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": true, + "type": "string" + }, { "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, @@ -58839,12 +62991,11 @@ "type": "string" }, { - "description": "Creates the account under the specified role.", + "description": "The id of the domain that is to contain the linked account.", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "since": "4.19.1", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, "type": "uuid" }, { @@ -58855,11 +63006,12 @@ "type": "string" }, { - "description": "The id of the domain that is to contain the linked account.", + "description": "Creates the account under the specified role.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": true, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "since": "4.19.1", "type": "uuid" }, { @@ -58868,41 +63020,30 @@ "name": "account", "required": true, "type": "string" - }, - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": true, - "type": "string" } ], "related": "", "response": [ + {}, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "type": "string" }, { "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "name": "ldapdomain", "type": "string" }, + {}, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, - {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -58911,16 +63052,20 @@ "type": "integer" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, + { + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" + }, { "description": "id of the Domain which is linked to LDAP", "name": "domainid", "type": "string" - }, - {} + } ], "since": "4.11.0" }, @@ -58941,34 +63086,31 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, + {}, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, + {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the host", @@ -58976,13 +63118,18 @@ "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { @@ -58990,23 +63137,21 @@ "name": "port", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "the operation result", + "name": "status", + "type": "boolean" + } ], "since": "4.9.0" }, @@ -59027,92 +63172,96 @@ "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { @@ -59120,6 +63269,11 @@ "name": "vgputype", "type": "string" }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, { "description": "Video RAM for this vGPU type", "name": "videoram", @@ -59130,19 +63284,14 @@ "name": "maxheads", "type": "long" }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, { "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", "name": "maxcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { @@ -59152,25 +63301,24 @@ } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, - {}, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { "description": "true if the host is disconnected. False otherwise.", @@ -59178,44 +63326,45 @@ "type": "date" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, + {}, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { "description": "the host type", @@ -59223,98 +63372,124 @@ "type": "type" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, { "description": "Host details in key/value pairs.", "name": "details", "type": "map" }, + {}, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { @@ -59323,99 +63498,120 @@ "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, + {}, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" } ], "since": "4.16.0.0" @@ -59443,27 +63639,27 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.20.0" }, @@ -59480,56 +63676,66 @@ "type": "string" }, { - "description": "Create security group for project", + "description": "the description of the security group", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the description of the security group", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "description", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "Create security group for project", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updateSecurityGroup", "response": [ { - "description": "the project name of the group", - "name": "project", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { "description": "the code for the ICMP message response", @@ -59537,23 +63743,8 @@ "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -59561,23 +63752,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -59586,8 +63767,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -59600,42 +63781,67 @@ "name": "domain", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], @@ -59646,227 +63852,217 @@ "name": "domainid", "type": "string" }, + {}, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, - {}, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the account owning the security group", + "name": "account", + "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "account owning the security group rule", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" } ], "type": "set" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" } ] @@ -59887,51 +64083,51 @@ ], "related": "", "response": [ - { - "description": "the network ID", - "name": "networkid", - "type": "string" - }, { "description": "the ID of project the network is available for", "name": "projectid", "type": "string" }, { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the name of the domain to which the network belongs", - "name": "domain", + "description": "the project the network is available for", + "name": "project", "type": "string" }, { - "description": "the project the network is available for", - "name": "project", + "description": "the account the network is available for", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of account the network is available for", + "name": "accountid", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the account the network is available for", - "name": "account", + "description": "the ID of the domain to which the network belongs", + "name": "domainid", "type": "string" }, { - "description": "the ID of account the network is available for", - "name": "accountid", + "description": "the name of the domain to which the network belongs", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the network ID", + "name": "networkid", "type": "string" } ], @@ -59942,45 +64138,45 @@ "isasync": true, "name": "removeVirtualMachineFromBackupOffering", "params": [ - { - "description": "Whether to force remove VM from the backup offering that may also delete VM backups.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "uuid" + }, + { + "description": "Whether to force remove VM from the backup offering that may also delete VM backups.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ], "since": "4.14.0" }, @@ -59992,18 +64188,10 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "id of vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": false, - "type": "uuid" - }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -60012,41 +64200,41 @@ "type": "string" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "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.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "", + "description": "id of vpc", "length": 255, - "name": "pagesize", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "id of the vpn gateway", @@ -60065,18 +64253,42 @@ "type": "uuid" }, { - "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.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createVpnGateway,updateVpnGateway", "response": [ { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the public IP address", + "name": "publicip", "type": "string" }, { @@ -60084,34 +64296,137 @@ "name": "vpcname", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" + }, { "description": "is vpn gateway for display to the regular user", "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the project name", - "name": "project", + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + } + ] + }, + { + "description": "Add Netris Provider to CloudStack", + "isasync": false, + "name": "addNetrisProvider", + "params": [ + { + "description": "Netris tag for vNets", + "length": 255, + "name": "netristag", + "required": true, "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Password to login into Netris", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "Netris Tenant name", + "length": 255, + "name": "tenantname", + "required": true, "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "Netris Site name", + "length": 255, + "name": "sitename", + "required": true, + "type": "string" + }, + { + "description": "Username to login into Netris", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "Netris provider URL", + "length": 255, + "name": "netrisurl", + "required": true, + "type": "string" + }, + { + "description": "Netris provider name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listNetrisProviders,deleteNetrisProvider", + "response": [ + { + "description": "Netris provider uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Netris Provider name", + "name": "name", + "type": "string" + }, + { + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, { @@ -60120,39 +64435,48 @@ "type": "integer" }, { - "description": "the owner", - "name": "account", + "description": "Netris Admin tenant name", + "name": "tenantname", "type": "string" }, - {}, - {}, { - "description": "the project id", - "name": "projectid", + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "Netris Provider URL", + "name": "netrisurl", "type": "string" }, + {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "Netris Tag for vNets", + "name": "netristag", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Netris Provider site", + "name": "sitename", "type": "string" } - ] + ], + "since": "4.21.0" }, { "description": "Moves a user to another account in the same domain.", "isasync": false, "name": "moveUser", "params": [ + { + "description": "id of the user to be moved.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + }, { "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", "length": 255, @@ -60167,38 +64491,30 @@ "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" - }, - { - "description": "id of the user to be moved.", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", - "required": true, - "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" @@ -60219,26 +64535,26 @@ ], "response": [ {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -60247,6 +64563,13 @@ "isasync": true, "name": "createVpnConnection", "params": [ + { + "description": "connection is passive or not", + "length": 255, + "name": "passive", + "required": false, + "type": "boolean" + }, { "description": "id of the vpn gateway", "length": 255, @@ -60255,14 +64578,6 @@ "required": true, "type": "uuid" }, - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "id of the customer gateway", "length": 255, @@ -60272,29 +64587,41 @@ "type": "uuid" }, { - "description": "connection is passive or not", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "passive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" } ], "related": "updateVpnConnection", "response": [ + {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { "description": "is connection for display to the regular user", @@ -60302,14 +64629,14 @@ "type": "boolean" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { "description": "State of vpn connection", @@ -60322,29 +64649,28 @@ "type": "integer" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, - {}, { "description": "if DPD is enabled for customer gateway", "name": "dpd", "type": "boolean" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" + }, + { + "description": "the owner", + "name": "account", "type": "string" }, { @@ -60353,18 +64679,18 @@ "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -60373,56 +64699,46 @@ "type": "date" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { "description": "the domain name of the owner", "name": "domain", "type": "string" }, - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" - }, - {}, - { - "description": "the owner", - "name": "account", - "type": "string" - } + {} ] }, { @@ -60444,6 +64760,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "brocade vcs switch ID", "length": 255, @@ -60451,196 +64774,109 @@ "related": "", "required": true, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ - {}, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { "description": "the total number of network traffic bytes sent", "name": "sentbytes", "type": "long" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the owner of the network", - "name": "account", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, { "description": "the displaytext of the network", "name": "displaytext", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { @@ -60648,23 +64884,18 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -60673,8 +64904,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -60683,141 +64914,167 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], "type": "list" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { @@ -60826,48 +65083,33 @@ "type": "map" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { @@ -60883,11 +65125,6 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", @@ -60899,9 +65136,9 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "uuid of the network provider", @@ -60909,14 +65146,19 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "the provider name", "name": "name", "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -60925,11 +65167,6 @@ "description": "the list of capabilities", "name": "capability", "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, { "description": "the capability value", "name": "value", @@ -60939,6 +65176,11 @@ "description": "the capability name", "name": "name", "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" @@ -60947,91 +65189,181 @@ "type": "list" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, { "description": "The Ipv6 routing type of network offering", "name": "ip6routing", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, { "description": "network offering id the network is created from", "name": "networkofferingid", "type": "string" }, - {}, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" } ] }, { - "description": "Lists Webhook deliveries", + "description": "Deletes a vGPU profile from the system", "isasync": false, - "name": "listWebhookDeliveries", + "name": "deleteGpuDevice", "params": [ { - "description": "", + "description": "comma separated list of IDs of the GPU device", "length": 255, - "name": "page", - "required": false, + "name": "ids", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "list" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "The ID of the Webhook delivery", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Lists Webhook deliveries", + "isasync": false, + "name": "listWebhookDeliveries", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "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.", + "description": "The ID of the management server", "length": 255, - "name": "startdate", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "date" + "type": "uuid" }, { "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.", @@ -61041,11 +65373,19 @@ "type": "date" }, { - "description": "The event type of the Webhook delivery", + "description": "", "length": 255, - "name": "eventtype", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" }, { "description": "The ID of the Webhook", @@ -61056,37 +65396,44 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "The event type of the Webhook delivery", "length": 255, - "name": "keyword", + "name": "eventtype", "required": false, "type": "string" }, { - "description": "The ID of the management server", + "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.", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createWebhook", "response": [ { - "description": "The account associated with the Webhook", - "name": "account", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, + {}, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "The name of the Webhook", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", + "type": "string" }, { "description": "The description of the Webhook", @@ -61094,60 +65441,53 @@ "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Whether SSL verification is enabled for the Webhook", "name": "sslverification", "type": "boolean" }, - { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "The secret key for the Webhook", - "name": "secretkey", - "type": "string" - }, - {}, { "description": "The name of the domain in which the Webhook exists", "name": "domain", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "The name of the Webhook", - "name": "name", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, + { + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" + }, { "description": "The ID of the Webhook", "name": "id", "type": "string" }, { - "description": "The state of the Webhook", - "name": "state", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { @@ -61155,10 +65495,16 @@ "name": "domainpath", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" } ], "since": "4.20.0" @@ -61194,15 +65540,9 @@ ], "related": "listDedicatedHosts", "response": [ - {}, - { - "description": "the name of the host", - "name": "hostname", - "type": "string" - }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, {}, @@ -61216,27 +65556,119 @@ "name": "id", "type": "string" }, + { + "description": "the Account ID of the host", + "name": "accountid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the name of the host", + "name": "hostname", + "type": "string" + }, { "description": "the domain ID of the host", "name": "domainid", "type": "string" + } + ] + }, + { + "description": "Lists storage access groups", + "isasync": false, + "name": "listStorageAccessGroups", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Name of the Storage access group", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the storage access group", + "name": "id", + "type": "string" + }, + { + "description": "List of Storage Pools in the Storage Access Group", + "name": "storagepools", + "type": "listresponse" + }, + { + "description": "the name of the storage access group", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "List of Hosts in the Storage Access Group", + "name": "hosts", + "type": "listresponse" + }, + { + "description": "List of Pods in the Storage Access Group", + "name": "pods", + "type": "listresponse" + }, + { + "description": "List of Zones in the Storage Access Group", + "name": "zones", + "type": "listresponse" + }, + {}, + { + "description": "List of Clusters in the Storage Access Group", + "name": "clusters", + "type": "listresponse" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] + }, + {} + ], + "since": "4.21.0" }, { "description": "Adds the GloboDNS external host", @@ -61244,41 +65676,37 @@ "name": "addGloboDnsHost", "params": [ { - "description": "the Physical Network ID", + "description": "Password for GloboDNS", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Password for GloboDNS", + "description": "Username for GloboDNS", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "GloboDNS url", + "description": "the Physical Network ID", "length": 255, - "name": "url", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Username for GloboDNS", + "description": "GloboDNS url", "length": 255, - "name": "username", + "name": "url", "required": true, "type": "string" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -61289,7 +65717,11 @@ "name": "displaytext", "type": "string" }, - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -61304,8 +65736,14 @@ "isasync": false, "name": "logout", "params": [], - "related": "samlSlo", + "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -61316,12 +65754,6 @@ "description": "Response description", "name": "description", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -61331,25 +65763,25 @@ "name": "importRole", "params": [ { - "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).", + "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", "length": 255, - "name": "ispublic", + "name": "forced", "required": false, "type": "boolean" }, { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "rules", - "required": true, - "type": "map" + "name": "type", + "required": false, + "type": "string" }, { - "description": "Creates a role with this unique name", + "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", "length": 255, - "name": "name", + "name": "rules", "required": true, - "type": "string" + "type": "map" }, { "description": "The description of the role", @@ -61359,18 +65791,18 @@ "type": "string" }, { - "description": "Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.", + "description": "Creates a role with this unique name", "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "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).", "length": 255, - "name": "type", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" } ], "related": "createRole,listRoles,updateRole", @@ -61380,27 +65812,21 @@ "name": "name", "type": "string" }, - {}, - {}, - { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { - "description": "the description of the role", - "name": "description", + "description": "the type of the role", + "name": "type", "type": "string" }, + {}, { "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).", "name": "ispublic", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the role", + "name": "description", + "type": "string" }, { "description": "the state of the role", @@ -61413,13 +65839,19 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "description": "the type of the role", - "name": "type", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -61431,16 +65863,9 @@ "name": "quotaEmailTemplateUpdate", "params": [ { - "description": "The locale of the email text", + "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", "length": 255, - "name": "locale", - "required": false, - "type": "string" - }, - { - "description": "The quota email template body, max: 500k characters", - "length": 512000, - "name": "templatebody", + "name": "templatetype", "required": true, "type": "string" }, @@ -61452,14 +65877,32 @@ "type": "string" }, { - "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "description": "The locale of the email text", "length": 255, - "name": "templatetype", + "name": "locale", + "required": false, + "type": "string" + }, + { + "description": "The quota email template body, max: 500k characters", + "length": 512000, + "name": "templatebody", "required": true, "type": "string" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -61470,20 +65913,94 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + } + ], + "since": "4.7.0" + }, + { + "description": "Lists quota credits of an account.", + "isasync": false, + "name": "quotaCreditsList", + "params": [ + { + "description": "Start date of the credit statement. If not provided, the first day of the current month will be considered as the start 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 \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "Whether to generate the credit statement for the provided domain and its children. Defaults to false.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "End date of the credit statement. If not provided, the current date will be considered as the end 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.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "ID of the account for which the credit statement will be generated.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the domain for which credit statement will be generated. Available only for administrators.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + } + ], + "related": "quotaCredits", + "response": [ + {}, + { + "description": "The credit deposited.", + "name": "credit", + "type": "bigdecimal" + }, + { + "description": "Credit's currency.", + "name": "currency", + "type": "string" + }, + { + "description": "Username of the creditor user.", + "name": "creditorusername", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "ID of the creditor user.", + "name": "creditoruserid", + "type": "string" }, - {} + { + "description": "When the credit was added.", + "name": "creditedon", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], - "since": "4.7.0" + "since": "4.21.0" }, { "description": "Restart a Shared FileSystem", @@ -61507,28 +66024,28 @@ } ], "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.20.0" }, @@ -61538,31 +66055,31 @@ "name": "listNetworkServiceProviders", "params": [ { - "description": "List by keyword", + "description": "list providers by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "page", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list providers by name", + "description": "list providers by state", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, @@ -61574,33 +66091,35 @@ "type": "integer" }, { - "description": "list providers by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" } ], "related": "addNetworkServiceProvider,listTrafficTypes", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "state of the network provider", + "name": "state", + "type": "string" }, + {}, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -61609,8 +66128,8 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -61624,12 +66143,10 @@ "type": "integer" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - {}, - {} + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } ], "since": "3.0.0" }, @@ -61656,9 +66173,9 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -61666,17 +66183,17 @@ "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -61694,27 +66211,27 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.19.0" @@ -61734,27 +66251,27 @@ } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -61773,18 +66290,11 @@ } ], "response": [ - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -61794,7 +66304,14 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -61820,35 +66337,35 @@ ], "related": "listSecondaryStorageSelectors", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Name of the heuristic.", "name": "name", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", - "type": "string" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", "name": "heuristicrule", "type": "string" }, + {}, { - "description": "ID of the heuristic.", - "name": "id", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" + }, + { + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -61856,22 +66373,22 @@ "name": "description", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The zone which the heuristic is valid upon.", "name": "zoneid", "type": "string" }, - {}, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "ID of the heuristic.", + "name": "id", + "type": "string" }, - { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" - } + {} ], "since": "4.19.0" }, @@ -61891,17 +66408,6 @@ ], "related": "createUser,disableUser,getUser,listUsers,lockUser", "response": [ - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - {}, { "description": "the type of the role", "name": "roletype", @@ -61913,18 +66419,13 @@ "type": "integer" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -61933,28 +66434,44 @@ "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + {}, + { + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -61963,55 +66480,50 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, - {}, { - "description": "the user state", - "name": "state", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, + {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the api key of the user", @@ -62019,13 +66531,18 @@ "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "type": "string" } ] @@ -62036,19 +66553,26 @@ "name": "quotaTariffCreate", "params": [ { - "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", + "description": "Quota tariff's description.", "length": 65535, - "name": "activationrule", + "name": "description", "required": false, "type": "string" }, { - "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current 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 \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "description": "The end date of the quota tariff. If not informed, the tariff will be valid indefinitely. 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.", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" }, + { + "description": "Quota tariff's activation rule. It can receive a JS script that results in either a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the numeric value will be applied; if the result is neither a boolean nor a numeric value, the tariff will not be applied. If the rule is not informed, the tariff value will be applied.", + "length": 65535, + "name": "activationrule", + "required": false, + "type": "string" + }, { "description": "The quota tariff value of the resource as per the default unit.", "length": 255, @@ -62057,25 +66581,18 @@ "type": "double" }, { - "description": "Position in the execution sequence for tariffs of the same type", - "length": 255, - "name": "position", - "required": false, - "since": "4.20.0.0", - "type": "integer" - }, - { - "description": "The end date of the quota tariff. If not informed, the tariff will be valid indefinitely. 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.", + "description": "The effective start date on/after which the quota tariff is effective. Inform null to use the current 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 \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" }, { - "description": "Integer value for the usage type of the resource.", + "description": "Position in the execution sequence for tariffs of the same type", "length": 255, - "name": "usagetype", - "required": true, + "name": "position", + "required": false, + "since": "4.20.0.0", "type": "integer" }, { @@ -62086,29 +66603,29 @@ "type": "string" }, { - "description": "Quota tariff's description.", - "length": 65535, - "name": "description", - "required": false, - "type": "string" + "description": "Integer value for the usage type of the resource.", + "length": 255, + "name": "usagetype", + "required": true, + "type": "integer" } ], "related": "quotaTariffList", "response": [ + {}, { - "description": "usageUnit", - "name": "usageUnit", + "description": "description", + "name": "description", "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, - {}, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { @@ -62116,10 +66633,9 @@ "name": "usageTypeDescription", "type": "string" }, - {}, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "the ID of the tariff", + "name": "id", "type": "string" }, { @@ -62128,23 +66644,23 @@ "type": "int" }, { - "description": "usageName", - "name": "usageName", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" + "description": "usageUnit", + "name": "usageUnit", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name", + "name": "name", "type": "string" }, { - "description": "description", - "name": "description", + "description": "currency", + "name": "currency", "type": "string" }, { @@ -62153,34 +66669,35 @@ "type": "date" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", + "type": "integer" }, + {}, { "description": "tariffValue", "name": "tariffValue", "type": "bigdecimal" }, { - "description": "name", - "name": "name", - "type": "string" + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" }, { - "description": "the ID of the tariff", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "when the quota tariff was removed", - "name": "removed", + "description": "the end date of the quota tariff", + "name": "endDate", "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "usageName", + "name": "usageName", + "type": "string" } ], "since": "4.18.0.0" @@ -62202,18 +66719,23 @@ "related": "activateProject,createProject", "response": [ { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { @@ -62222,258 +66744,318 @@ "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, + {}, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { - "description": "the name of the project", - "name": "name", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, + { + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" + }, { "description": "the total primary storage space (in GiB) owned by project", "name": "primarystoragetotal", "type": "long" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the account name of the project's owners", + "name": "owner", "type": "list" }, + {}, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" }, { "description": "the domain id the project belongs to", @@ -62481,28 +67063,38 @@ "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of buckets stored by this project", + "name": "buckettotal", "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" } ], @@ -62515,42 +67107,42 @@ "params": [], "related": "", "response": [ - { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" - }, { "description": "the account name of the api remaining count", "name": "account", "type": "string" }, - {}, { - "description": "the account uuid of the api remaining count", - "name": "accountid", - "type": "string" + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" }, { "description": "seconds left to reset counters", "name": "expireAfter", "type": "long" }, + {}, { - "description": "number of api already issued", - "name": "apiIssued", - "type": "int" + "description": "the account uuid of the api remaining count", + "name": "accountid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -62569,18 +67161,12 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -62590,7 +67176,13 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ], "since": "3.0.0" }, @@ -62638,12 +67230,6 @@ ], "related": "", "response": [ - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -62659,16 +67245,22 @@ "name": "name", "type": "string" }, - {}, { "description": "The VMware vCenter name/ip", "name": "vcenter", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" } ] }, @@ -62678,34 +67270,32 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "customid", + "name": "endport", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the ID of the ipv6 firewall rule", + "description": "type of the ICMP message being sent", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule,listRoutingFirewallRules", - "required": true, - "type": "uuid" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the starting port of Ipv6 firewall rule", + "description": "error code for this ICMP message", "length": 255, - "name": "startport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "cidrlist", + "name": "protocol", "required": false, - "type": "list" + "type": "string" }, { "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", @@ -62716,77 +67306,59 @@ "type": "boolean" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the ID of the ipv6 firewall rule", "length": 255, - "name": "protocol", - "required": false, - "type": "string" + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { - "description": "error code for this ICMP message", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "icmpcode", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmptype", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "endport", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "traffictype", + "name": "startport", "required": false, - "type": "string" + "type": "integer" } ], - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { @@ -62795,44 +67367,33 @@ "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - {}, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -62840,33 +67401,33 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -62875,36 +67436,67 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, { "description": "is firewall for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" } ] @@ -62915,45 +67507,45 @@ "name": "updateIsoPermissions", "params": [ { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, - "type": "string" - }, - { - "description": "true for featured template/iso, false otherwise", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "isfeatured", + "name": "accounts", "required": false, - "type": "boolean" + "type": "list" }, { "description": "the template ID", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "isextractable", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "accounts", + "name": "ispublic", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "ispublic", + "name": "op", + "required": false, + "type": "string" + }, + { + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "length": 255, + "name": "isextractable", "required": false, "type": "boolean" }, @@ -62967,28 +67559,28 @@ } ], "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {}, + {} ] }, { @@ -63006,10 +67598,14 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -63019,15 +67615,11 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -63052,86 +67644,40 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Sends an email to the user with a token to reset the password using resetPassword command.", + "description": "List Autonomous Systems Number Ranges", "isasync": false, - "name": "forgotPassword", + "name": "listASNRanges", "params": [ { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "", "length": 255, - "name": "domain", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Username", + "description": "List by keyword", "length": 255, - "name": "username", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.20.0.0" - }, - { - "description": "List Autonomous Systems Number Ranges", - "isasync": false, - "name": "listASNRanges", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "name": "keyword", + "required": false, "type": "string" }, { @@ -63145,7 +67691,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -63157,37 +67703,37 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "Zone ID", - "name": "zoneid", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "ID of the AS Number Range", - "name": "id", - "type": "string" - }, - {}, { "description": "Start AS Number", "name": "startasn", "type": "long" }, { - "description": "Created date", - "name": "created", - "type": "date" + "description": "Zone ID", + "name": "zoneid", + "type": "string" }, { "description": "End AS Number", "name": "endasn", "type": "long" }, + { + "description": "ID of the AS Number Range", + "name": "id", + "type": "string" + }, + { + "description": "Created date", + "name": "created", + "type": "date" + }, {} ], "since": "4.20.0" @@ -63198,16 +67744,16 @@ "name": "createTungstenFabricTag", "params": [ { - "description": "Tungsten-Fabric tag type", + "description": "Tungsten-Fabric tag value", "length": 255, - "name": "tagtype", + "name": "tagvalue", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric tag value", + "description": "Tungsten-Fabric tag type", "length": 255, - "name": "tagvalue", + "name": "tagtype", "required": true, "type": "string" }, @@ -63223,56 +67769,56 @@ "related": "listTungstenFabricTag,applyTungstenFabricTag", "response": [ { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "list Tungsten-Fabric network", "name": "network", "type": "list" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, {}, + {}, + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list Tungsten-Fabric nic", - "name": "nic", + "description": "list Tungsten-Fabric vm", + "name": "vm", "type": "list" }, { "description": "Tungsten-Fabric tag name", "name": "name", "type": "string" + }, + { + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" } ] }, @@ -63289,12 +67835,11 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Api URL of the OpenDaylight Controller.", @@ -63304,33 +67849,24 @@ "type": "string" }, { - "description": "Username to access the OpenDaylight API", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" } ], "related": "deleteOpenDaylightController", "response": [ { - "description": "the username to authenticate to the controller", - "name": "username", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the url of the controller api", - "name": "url", + "description": "device id of the controller", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { @@ -63343,13 +67879,23 @@ "name": "physicalnetworkid", "type": "string" }, - {}, + { + "description": "the url of the controller api", + "name": "url", + "type": "string" + }, {}, { - "description": "device id of the controller", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -63358,31 +67904,39 @@ "name": "createZone", "params": [ { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the second DNS for the Zone", "length": 255, - "name": "ip6dns2", + "name": "dns2", "required": false, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "Network domain name for the networks in the zone", "length": 255, - "name": "localstorageenabled", + "name": "domain", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "comma separated list of storage access groups for the hosts in the zone", "length": 255, - "name": "ip6dns1", + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" + }, + { + "description": "the second internal DNS for the Zone", + "length": 255, + "name": "internaldns2", "required": false, "type": "string" }, { - "description": "network type of the zone, can be Basic or Advanced", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "networktype", - "required": true, + "name": "ip6dns1", + "required": false, "type": "string" }, { @@ -63394,154 +67948,164 @@ "type": "boolean" }, { - "description": "the name of the Zone", + "description": "the ID of the containing domain, null for public zones", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the guest CIDR address for the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "guestcidraddress", + "name": "ip6dns2", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "Allocation state of this Zone for allocation of new resources", "length": 255, - "name": "internaldns1", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the ID of the containing domain, null for public zones", + "description": "true if network is security group enabled, false otherwise", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "securitygroupenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "the first DNS for the Zone", "length": 255, - "name": "allocationstate", - "required": false, + "name": "dns1", + "required": true, "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "internaldns2", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "network type of the zone, can be Basic or Advanced", "length": 255, - "name": "dns1", + "name": "networktype", "required": true, "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "dns2", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "securitygroupenabled", + "name": "localstorageenabled", "required": false, "type": "boolean" }, { - "description": "Network domain name for the networks in the zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "domain", - "required": false, + "name": "internaldns1", + "required": true, "type": "string" } ], "related": "listZones", "response": [ { - "description": "the type of the zone - core or edge", - "name": "type", - "type": "string" + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "Zone name", - "name": "name", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, { "description": "true if security groups support is enabled, false otherwise", "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "Zone id", + "name": "id", "type": "string" }, - {}, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -63549,24 +68113,25 @@ "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "External network provider if any", + "name": "provider", "type": "string" }, + {}, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { "description": "the first IPv6 DNS for the Zone", @@ -63574,63 +68139,77 @@ "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, - {}, { "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -63639,75 +68218,65 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, { "description": "the Pod name", "name": "podname", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -63720,11 +68289,26 @@ "name": "type", "type": "short" }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, { "description": "the capacity currently in use", "name": "capacityused", "type": "long" }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, { "description": "the capacity currently in allocated", "name": "capacityallocated", @@ -63736,36 +68320,26 @@ "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the capacity name", + "name": "name", "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", "type": "boolean" } ] @@ -63783,11 +68357,11 @@ "type": "string" }, { - "description": "list children domains by name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -63797,31 +68371,23 @@ "type": "integer" }, { - "description": "list children domain by parent domain ID.", - "length": 255, - "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "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", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "", + "description": "list children domains by name", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "flag to display the resource icon for domains", + "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", "length": 255, - "name": "showicon", + "name": "listall", "required": false, "type": "boolean" }, @@ -63831,99 +68397,111 @@ "name": "isrecursive", "required": false, "type": "boolean" + }, + { + "description": "list children domain by parent domain ID.", + "length": 255, + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], "related": "createDomain,listDomains,listDomains,moveDomain", "response": [ { - "description": "the state of the domain", - "name": "state", + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - { - "description": "the path of the domain", - "name": "path", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, - {}, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { @@ -63932,33 +68510,43 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { @@ -63966,39 +68554,55 @@ "name": "snapshotavailable", "type": "string" }, + {}, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the state of the domain", + "name": "state", "type": "string" }, { @@ -64007,44 +68611,55 @@ "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the path of the domain", + "name": "path", + "type": "string" }, + {}, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { "description": "the total number of cpu cores available to be created for this domain", @@ -64052,9 +68667,9 @@ "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" }, { "description": "the total primary storage space (in GiB) owned by domain", @@ -64062,40 +68677,74 @@ "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, - {}, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" } ] }, @@ -64108,30 +68757,30 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importUnmanagedInstance,importVm", + "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", "required": true, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "The base64 encoded encrypted password of the VM", "name": "encryptedpassword", "type": "string" - }, - {} + } ] }, { @@ -64140,12 +68789,12 @@ "name": "assignToGlobalLoadBalancerRule", "params": [ { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "loadbalancerrulelist", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": true, - "type": "list" + "type": "uuid" }, { "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", @@ -64155,37 +68804,37 @@ "type": "map" }, { - "description": "the ID of the global load balancer rule", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "loadbalancerrulelist", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, - "type": "uuid" + "type": "list" } ], "response": [ + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -64193,13 +68842,6 @@ "isasync": false, "name": "addImageStoreS3", "params": [ - { - "description": "S3 access key", - "length": 255, - "name": "accesskey", - "required": true, - "type": "string" - }, { "description": "Socket timeout (milliseconds)", "length": 255, @@ -64207,13 +68849,6 @@ "required": false, "type": "integer" }, - { - "description": "Connection TTL (milliseconds)", - "length": 255, - "name": "connectionttl", - "required": false, - "type": "integer" - }, { "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, @@ -64222,37 +68857,44 @@ "type": "string" }, { - "description": "S3 endpoint", + "description": "S3 secret key", "length": 255, - "name": "endpoint", + "name": "secretkey", "required": true, "type": "string" }, { - "description": "Name of the storage bucket", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "bucket", + "name": "connectiontimeout", + "required": false, + "type": "integer" + }, + { + "description": "S3 endpoint", + "length": 255, + "name": "endpoint", "required": true, "type": "string" }, { - "description": "Maximum number of times to retry on error", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "maxerrorretry", + "name": "connectionttl", "required": false, "type": "integer" }, { - "description": "Connection timeout (milliseconds)", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "connectiontimeout", + "name": "maxerrorretry", "required": false, "type": "integer" }, { - "description": "S3 secret key", + "description": "Name of the storage bucket", "length": 255, - "name": "secretkey", + "name": "bucket", "required": true, "type": "string" }, @@ -64269,6 +68911,13 @@ "name": "usetcpkeepalive", "required": false, "type": "boolean" + }, + { + "description": "S3 access key", + "length": 255, + "name": "accesskey", + "required": true, + "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", @@ -64279,34 +68928,24 @@ "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "the name of the image store", - "name": "name", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the total disk size of the host", @@ -64319,32 +68958,42 @@ "name": "hasannotations", "type": "boolean" }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the name of the image store", + "name": "name", "type": "string" }, - {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { "description": "the url of the image store", "name": "url", "type": "string" - } + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + {} ], "since": "4.7.0" }, @@ -64354,17 +69003,16 @@ "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "(optional) the host ID to upload certificate", + "description": "Hypervisor type", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", + "description": "SSL certificate", + "length": 65535, + "name": "certificate", "required": true, "type": "string" }, @@ -64377,42 +69025,41 @@ "type": "uuid" }, { - "description": "Hypervisor type", + "description": "Name for the uploaded certificate", "length": 255, - "name": "hypervisor", + "name": "name", "required": true, "type": "string" }, { - "description": "SSL certificate", - "length": 65535, - "name": "certificate", - "required": true, - "type": "string" + "description": "(optional) the host ID to upload certificate", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" } ], "related": "listTemplateDirectDownloadCertificates", "response": [ { - "description": "the direct download certificate issuer", - "name": "issuer", - "type": "string" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, - {}, { "description": "the direct download certificate serial num", "name": "serialnum", "type": "string" }, - {}, { - "description": "the direct download certificate id", - "name": "id", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, { @@ -64420,16 +69067,6 @@ "name": "hypervisor", "type": "string" }, - { - "description": "the direct download certificate version", - "name": "version", - "type": "string" - }, - { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -64440,11 +69077,6 @@ "name": "zonename", "type": "string" }, - { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", - "type": "string" - }, { "description": "the direct download certificate alias", "name": "alias", @@ -64456,10 +69088,27 @@ "type": "integer" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" - } + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + { + "description": "the direct download certificate subject", + "name": "subject", + "type": "string" + }, + {}, + { + "description": "the direct download certificate version", + "name": "version", + "type": "string" + }, + { + "description": "the direct download certificate issuer", + "name": "issuer", + "type": "string" + }, + {} ], "since": "4.11.0" }, @@ -64469,26 +69118,42 @@ "name": "importUnmanagedInstance", "params": [ { - "description": "import instance for the project", + "description": "import instance to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the display name of the instance", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "displayname", + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, + "type": "uuid" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the instance as it is known to the hypervisor", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "used to specify the custom parameters.", + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", "length": 255, - "name": "details", + "name": "migrateallowed", "required": false, - "type": "map" + "type": "boolean" }, { "description": "VM nic to network id mapping using keys nic and network", @@ -64498,18 +69163,19 @@ "type": "map" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "the display name of the instance", "length": 255, - "name": "datadiskofferinglist", + "name": "displayname", "required": false, - "type": "map" + "type": "string" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "import instance for the project", "length": 255, - "name": "migrateallowed", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "VM 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", @@ -64526,144 +69192,455 @@ "type": "string" }, { - "description": "the name of the instance as it is known to the hypervisor", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "nicipaddresslist", + "required": false, + "type": "map" }, { - "description": "import instance to the domain specified", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the cluster ID", + "description": "the service offering for the virtual machine", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "nicipaddresslist", + "name": "datadiskofferinglist", "required": false, "type": "map" }, { - "description": "the ID of the template for the virtual machine", + "description": "used to specify the custom parameters.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "details", "required": false, - "type": "uuid" + "type": "map" + } + ], + "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,importVm", + "response": [ + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the service offering for the virtual machine", - "length": 255, + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" - } - ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "response": [ + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, { "description": "CPU arch of the VM", "name": "arch", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "Id of the vm to which the nic belongs", @@ -64671,58 +69648,63 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, { "description": "Id of the vpc to which the nic belongs", "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -64730,81 +69712,96 @@ "name": "nsxlogicalswitch", "type": "string" }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -64813,19 +69810,14 @@ "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -64836,11 +69828,26 @@ "name": "icmptype", "type": "integer" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -64851,48 +69858,48 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -64903,135 +69910,63 @@ ], "type": "set" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" } ], "type": "set" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the id of the security group rule", "name": "ruleid", @@ -65042,33 +69977,28 @@ "name": "account", "type": "string" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -65081,6 +70011,11 @@ "name": "key", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -65092,50 +70027,102 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { "description": "the name of the security group", @@ -65143,51 +70130,47 @@ "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -65196,260 +70179,103 @@ "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - {}, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -65467,128 +70293,52 @@ "name": "account", "type": "string" }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, { "description": "the description of the affinity group", "name": "description", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { "description": "dedicated resources associated with this affinity group", "name": "dedicatedresources", "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" } ], "type": "set" }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, { "description": "Guest vm Boot Type", "name": "boottype", "type": "string" }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - {}, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, { "description": "the incoming network traffic on the VM in KiB", "name": "networkkbsread", "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -65596,102 +70346,94 @@ "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + } + ], + "since": "4.14.0" + }, + { + "description": "Unmanage a GPU device", + "isasync": false, + "name": "unmanageGpuDevice", + "params": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "comma separated list of IDs of the GPU device", + "length": 255, + "name": "ids", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "list" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "4.14.0" + "since": "4.21.0" }, { "description": "Creates a physical network", "isasync": true, "name": "createPhysicalNetwork", "params": [ - { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", - "length": 255, - "name": "broadcastdomainrange", - "required": false, - "type": "string" - }, { "description": "the Zone ID for the physical network", "length": 255, @@ -65700,14 +70442,6 @@ "required": true, "type": "uuid" }, - { - "description": "domain ID of the account owning a physical network", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "the name of the physical network", "length": 255, @@ -65715,13 +70449,6 @@ "required": true, "type": "string" }, - { - "description": "Tag the physical network", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, { "description": "the speed for the physical network[1G/10G]", "length": 255, @@ -65736,29 +70463,46 @@ "required": false, "type": "string" }, + { + "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "length": 255, + "name": "broadcastdomainrange", + "required": false, + "type": "string" + }, { "description": "the isolation method for the physical network[VLAN/L3/GRE]", "length": 255, "name": "isolationmethods", "required": false, "type": "list" + }, + { + "description": "Tag the physical network", + "length": 255, + "name": "tags", + "required": false, + "type": "list" + }, + { + "description": "domain ID of the account owning a physical network", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], "related": "listPhysicalNetworks,updatePhysicalNetwork", "response": [ { - "description": "isolation methods", - "name": "isolationmethods", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { @@ -65767,34 +70511,28 @@ "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the domain id of the physical network owner", "name": "domainid", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "name of the physical network", "name": "name", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "state of the physical network", + "name": "state", "type": "string" }, { @@ -65802,15 +70540,26 @@ "name": "networkspeed", "type": "string" }, + {}, + {}, { - "description": "state of the physical network", - "name": "state", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, - {}, { - "description": "comma separated tag", - "name": "tags", + "description": "zone id of the physical network", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" } ], @@ -65822,64 +70571,64 @@ "name": "listAutoScaleVmGroups", "params": [ { - "description": "the name of the autoscale vmgroup", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "name", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the profile", + "description": "the ID of the policy", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "name": "policyid", + "related": "listAutoScalePolicies", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the policy", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "name": "name", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "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.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { @@ -65891,147 +70640,143 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the availability zone ID", "length": 255, - "name": "isrecursive", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the loadbalancer", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the loadbalancer", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, "type": "uuid" }, { - "description": "the availability zone ID", + "description": "the ID of the profile", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "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.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], "related": "enableAutoScaleVmGroup", "response": [ + {}, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" - }, - { - "description": "the public ip address id", - "name": "publicipid", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, - {}, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { @@ -66039,51 +70784,55 @@ "name": "publicport", "type": "string" }, - {}, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, + { + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, { "description": "the public ip address", "name": "publicip", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the name of the autoscale vm group ", + "name": "name", + "type": "string" } ] }, @@ -66099,13 +70848,6 @@ "required": false, "type": "string" }, - { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, { "description": "the starting IP address for the Pod", "length": 255, @@ -66114,23 +70856,23 @@ "type": "string" }, { - "description": "the gateway for the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "gateway", + "name": "endip", "required": false, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "endip", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the netmask of the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "netmask", + "name": "gateway", "required": false, "type": "string" }, @@ -66141,190 +70883,207 @@ "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": true, "type": "uuid" - } - ], - "related": "createPod,listPods,createManagementNetworkIpRange", - "response": [ - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" }, { "description": "the netmask of the Pod", + "length": 255, "name": "netmask", + "required": false, "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, + } + ], + "related": "createPod,listPods,createManagementNetworkIpRange", + "response": [ { "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", "name": "endip", "type": "list" }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the gateway of the Pod", "name": "gateway", "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, {}, + {}, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { "description": "the Cluster ID", "name": "clusterid", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the ending IP for the range", + "name": "endip", + "type": "string" } ], "type": "list" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the name of the Pod", "name": "name", "type": "string" + }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" } ] }, @@ -66337,7 +71096,7 @@ "description": "the ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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,importVm", "required": true, "type": "uuid" }, @@ -66353,201 +71112,66 @@ "description": "the ID of the ISO file", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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", "response": [ { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { @@ -66555,36 +71179,30 @@ "name": "templatetype", "type": "string" }, - {}, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { "description": "true if high-availability is enabled, false otherwise", @@ -66592,19 +71210,14 @@ "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -66613,19 +71226,19 @@ "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { "description": "the date when this virtual machine was updated last time", @@ -66633,19 +71246,39 @@ "type": "date" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { "description": "the target memory in VM (KiB)", @@ -66653,77 +71286,83 @@ "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -66732,13 +71371,13 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -66747,29 +71386,29 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the isolated private VLAN if available", @@ -66777,73 +71416,63 @@ "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -66852,46 +71481,51 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" } ], "type": "set" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { @@ -66900,195 +71534,447 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, { "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -67097,23 +71983,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -67122,21 +72008,21 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -67145,8 +72031,13 @@ "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -67154,31 +72045,56 @@ "name": "protocol", "type": "string" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -67186,20 +72102,15 @@ "name": "securitygroupname", "type": "string" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", @@ -67211,8 +72122,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -67221,195 +72132,73 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" } ], "type": "set" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { "description": "the ID of the service offering of the virtual machine", @@ -67417,43 +72206,73 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" } ] @@ -67466,17 +72285,20 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", + "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" + }, { "description": "Specify the LDAP port if required, default is 389", "name": "port", @@ -67488,13 +72310,8 @@ "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", - "type": "string" - }, - { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "DN password", + "name": "bindpass", "type": "string" }, { @@ -67507,11 +72324,13 @@ "name": "searchbase", "type": "string" }, + {}, { - "description": "DN password", - "name": "bindpass", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "3.0.1" }, @@ -67521,118 +72340,123 @@ "name": "createUser", "params": [ { - "description": "lastname", + "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, - "name": "lastname", + "name": "account", "required": true, "type": "string" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "email", "length": 255, - "name": "password", + "name": "email", "required": true, "type": "string" }, { - "description": "firstname", + "description": "lastname", "length": 255, - "name": "firstname", + "name": "lastname", "required": true, "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", "length": 255, - "name": "account", + "name": "password", "required": true, "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "length": 255, - "name": "userid", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Unique username.", "length": 255, - "name": "timezone", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "userid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "email", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "email", - "required": true, + "name": "timezone", + "required": false, "type": "string" }, { - "description": "Unique username.", + "description": "firstname", "length": 255, - "name": "username", + "name": "firstname", "required": true, "type": "string" } ], "related": "disableUser,getUser,listUsers,lockUser", "response": [ - {}, { - "description": "the type of the role", - "name": "roletype", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user name", + "name": "username", "type": "string" }, + {}, { "description": "the account type of the user", "name": "accounttype", @@ -67643,46 +72467,51 @@ "name": "domain", "type": "string" }, + {}, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -67690,14 +72519,9 @@ "type": "integer" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { "description": "the date and time the user account was created", @@ -67705,86 +72529,219 @@ "type": "date" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" } ] }, { - "description": "Resets the password for the user using the token generated via forgotPassword command.", + "description": "Add a custom action for an extension", "isasync": false, - "name": "resetPassword", + "name": "addCustomAction", "params": [ { - "description": "Token generated via forgotPassword command.", + "description": "Whether the action is enabled or not. Default is disabled.", "length": 255, - "name": "token", - "required": true, - "type": "string" + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 seconds", "length": 255, - "name": "domain", + "name": "timeout", + "required": false, + "type": "integer" + }, + { + "description": "Description of the action", + "length": 255, + "name": "description", "required": false, "type": "string" }, { - "description": "New password in clear text (Default hashed to SHA256SALT).", + "description": "The ID of the extension to associate the action with", "length": 255, - "name": "password", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": true, + "type": "uuid" + }, + { + "description": "Success message that will be used on successful execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Successfully complete {{actionName}} for {{resourceName}} with {{extensionName}}", + "length": 255, + "name": "successmessage", + "required": false, "type": "string" }, { - "description": "Username", + "description": "Name of the action", "length": 255, - "name": "username", + "name": "name", "required": true, "type": "string" + }, + { + "description": "Error message that will be used on failure during execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Failed to complete {{actionName}} for {{resourceName}} with {{extensionName}}", + "length": 255, + "name": "errormessage", + "required": false, + "type": "string" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "List of role types allowed for the action", + "length": 255, + "name": "allowedroletypes", + "required": false, + "type": "list" + }, + { + "description": "Parameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx¶meters[0].type=BOOLEAN¶meters[0].required=true", + "length": 255, + "name": "parameters", + "required": false, + "type": "map" + }, + { + "description": "Resource type for which the action is available", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "string" } ], + "related": "listCustomActions", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of the parameters for the action", + "name": "parameters", + "response": [ + { + "description": "Whether the parameter is required or not", + "name": "required", + "type": "boolean" + }, + { + "description": "Validation format for value of the parameter. Available for specific types", + "name": "validationformat", + "type": "string" + }, + { + "description": "Comma-separated list of options for value of the parameter", + "name": "valueoptions", + "type": "list" + }, + { + "description": "Name of the parameter", + "name": "name", + "type": "string" + }, + { + "description": "Type of the parameter", + "name": "type", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "Name of the custom action", + "name": "name", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Name of the extension that this custom action belongs to", + "name": "extensionname", + "type": "string" + }, + { + "description": "Details of the custom action", + "name": "details", + "type": "map" + }, + { + "description": "Message that will be used on successful execution of the action", + "name": "successmessage", + "type": "string" + }, + { + "description": "List of role types allowed for the custom action", + "name": "allowedroletypes", + "type": "list" + }, + { + "description": "Specifies the timeout in seconds to wait for the action to complete before failing", + "name": "timeout", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Whether the custom action is enabled or not", + "name": "enabled", + "type": "boolean" + }, + { + "description": "Creation timestamp of the custom action", + "name": "created", + "type": "date" + }, + { + "description": "Description of the custom action", + "name": "description", "type": "string" }, - {} + {}, + { + "description": "ID of the custom action", + "name": "id", + "type": "string" + }, + { + "description": "ID of the extension that this custom action belongs to", + "name": "extensionid", + "type": "string" + }, + { + "description": "Message that will be used on failure during execution of the action", + "name": "errormessage", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Resource type for which the action is available", + "name": "resourcetype", + "type": "string" + } ], - "since": "4.20.0.0" + "since": "4.21.0" }, { "description": "Creates site to site vpn local gateway", @@ -67792,7 +72749,16 @@ "name": "createVpnGateway", "params": [ { - "description": "public ip address id of the vpn gateway", + "description": "the public IP address ID for which VPN gateway is being enabled. By default the source NAT IP or router IP will be used.", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "id of the vpc", "length": 255, "name": "vpcid", "related": "listVPCs,createVPC,listVPCs,updateVPC", @@ -67810,6 +72776,11 @@ ], "related": "updateVpnGateway", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "the domain name of the owner", @@ -67822,64 +72793,59 @@ "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, - {}, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the project name", + "name": "project", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "is vpn gateway for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id", - "name": "projectid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the owner", + "name": "account", "type": "string" }, + {}, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" } ] @@ -67920,18 +72886,11 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -67941,7 +72900,14 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { @@ -67950,31 +72916,24 @@ "name": "listVpnUsers", "params": [ { - "description": "the username of the vpn user.", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "The uuid of the Vpn user", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, @@ -67986,39 +72945,46 @@ "type": "string" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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.", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the username of the vpn user.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "The uuid of the Vpn user", + "length": 255, + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, "type": "uuid" } @@ -68026,45 +72992,39 @@ "related": "addVpnUser", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, + {}, { "description": "the username of the vpn user", "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the vpn userID", + "name": "id", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { @@ -68073,13 +73033,19 @@ "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, + {}, { - "description": "the vpn userID", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the remote access vpn", + "name": "account", "type": "string" } ] @@ -68093,108 +73059,108 @@ "description": "the ID of the forwarding rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, "type": "uuid" } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, { - "description": "Register a new userdata.", + "description": "Register a new User Data.", "isasync": false, "name": "registerUserData", "params": [ { - "description": "Base64 encoded userdata 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 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "description": "Name of the user data", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "description": "comma separated list of variables declared in user data content", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "params", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "comma separated list of variables declared in userdata content", + "description": "an optional account for the user data. Must be used with domainId.", "length": 255, - "name": "params", + "name": "account", "required": false, "type": "string" }, { - "description": "Name of the userdata", - "length": 255, - "name": "name", + "description": "User data content", + "length": 1048576, + "name": "userdata", "required": true, "type": "string" }, { - "description": "an optional project for the userdata", + "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "an optional account for the userdata. Must be used with domainId.", + "description": "an optional project for the user data", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "type": "string" + "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.18" @@ -68205,11 +73171,11 @@ "name": "addRegion", "params": [ { - "description": "Name of the region", + "description": "Id of the Region", "length": 255, - "name": "name", + "name": "id", "required": true, - "type": "string" + "type": "integer" }, { "description": "Region service endpoint", @@ -68219,36 +73185,26 @@ "type": "string" }, { - "description": "Id of the Region", + "description": "Name of the region", "length": 255, - "name": "id", + "name": "name", "required": true, - "type": "integer" + "type": "string" } ], "related": "updateRegion", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the region", - "name": "name", - "type": "string" - }, {}, {}, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the region", - "name": "id", - "type": "integer" + "description": "the end point of the region", + "name": "endpoint", + "type": "string" }, { "description": "true if security groups support is enabled, false otherwise", @@ -68256,14 +73212,24 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the region", + "name": "id", "type": "integer" }, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the name of the region", + "name": "name", "type": "string" + }, + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" } ] }, @@ -68272,13 +73238,6 @@ "isasync": false, "name": "generateUsageRecords", "params": [ - { - "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, { "description": "List events for the specified domain.", "length": 255, @@ -68293,18 +73252,20 @@ "name": "startdate", "required": false, "type": "date" + }, + { + "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", @@ -68313,9 +73274,14 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ] @@ -68326,12 +73292,13 @@ "name": "updateRolePermission", "params": [ { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Role permission rule id", "length": 255, - "name": "ruleorder", + "name": "ruleid", "related": "", "required": false, - "type": "list" + "since": "4.11", + "type": "uuid" }, { "description": "ID of the role", @@ -68342,21 +73309,20 @@ "type": "uuid" }, { - "description": "Role permission rule id", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "ruleid", - "related": "", + "name": "permission", "required": false, "since": "4.11", - "type": "uuid" + "type": "string" }, { - "description": "Rule permission, can be: allow or deny", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "permission", + "name": "ruleorder", + "related": "", "required": false, - "since": "4.11", - "type": "string" + "type": "list" } ], "response": [ @@ -68370,7 +73336,6 @@ "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -68381,6 +73346,7 @@ "name": "displaytext", "type": "string" }, + {}, {} ], "since": "4.9.0" @@ -68391,63 +73357,55 @@ "name": "listAccounts", "params": [ { - "description": "flag to display the resource icon for accounts", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, - { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", + "description": "list account by account name", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "List accounts by the Api key access value", + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", "length": 255, - "name": "apikeyaccess", + "name": "accounttype", "required": false, - "since": "4.20.1.0", - "type": "string" + "type": "integer" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Tag for resource type to return usage", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tag", + "name": "isrecursive", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "description": "list account by account ID", + "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.", "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "isrecursive", + "name": "details", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "description": "List accounts by the Api key access value", "length": 255, - "name": "iscleanuprequired", + "name": "apikeyaccess", "required": false, - "type": "boolean" + "since": "4.20.1.0", + "type": "string" }, { "description": "list accounts by state. Valid states are enabled, disabled, and locked.", @@ -68464,68 +73422,86 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "flag to display the resource icon for accounts", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list account by account name", + "description": "list accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "name", + "name": "iscleanuprequired", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "Tag for resource type to return usage", "length": 255, - "name": "keyword", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "description": "", "length": 255, - "name": "accounttype", + "name": "pagesize", "required": false, "type": "integer" }, { - "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.", + "description": "list account by account ID", "length": 255, - "name": "listall", + "name": "id", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "response": [ { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { "description": "The tagged resource limit and count for the account", @@ -68533,117 +73509,108 @@ "type": "list" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, + {}, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user name", - "name": "username", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -68652,151 +73619,147 @@ "type": "boolean" }, { - "description": "the user ID", - "name": "id", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user name", + "name": "username", "type": "string" }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the account name of the user", + "name": "account", "type": "string" }, { "description": "true if user is default, false otherwise", "name": "isdefault", "type": "boolean" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" } ], "type": "list" }, + {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { @@ -68805,146 +73768,224 @@ "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" }, { "description": "the total number of snapshots stored by this account", "name": "snapshottotal", "type": "long" }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, { "description": "the total secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" + }, { "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", "name": "roletype", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, { "description": "the list of acl groups that account belongs to", "name": "groups", "type": "list" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, - {}, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" } ] }, @@ -68965,65 +74006,29 @@ "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the account associated with the router", - "name": "account", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { @@ -69031,55 +74036,25 @@ "name": "domainid", "type": "string" }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, { "description": "the Pod ID for the router", "name": "podid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of VPC the router belongs to", @@ -69087,44 +74062,34 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, {}, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the gateway for the router", - "name": "gateway", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { @@ -69132,80 +74097,121 @@ "name": "healthchecksfailed", "type": "boolean" }, - {}, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, { "description": "the second IPv6 DNS for the router", "name": "ip6dns2", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { @@ -69213,104 +74219,104 @@ "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { "description": "public IP address id associated with this nic via Static nat rule", @@ -69318,33 +74324,28 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -69353,46 +74354,46 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -69401,28 +74402,58 @@ "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -69431,8 +74462,18 @@ "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", "type": "string" } ] @@ -69443,39 +74484,44 @@ "name": "listImageStores", "params": [ { - "description": "List by keyword", + "description": "the image store protocol", "length": 255, - "name": "keyword", + "name": "protocol", "required": false, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the image store provider", "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID for the image store", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the name of the image store", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -69489,44 +74535,34 @@ "type": "boolean" }, { - "description": "the image store provider", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - }, - { - "description": "the image store protocol", + "description": "the ID of the storage pool", "length": 255, - "name": "protocol", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the image store", + "description": "the Zone ID for the image store", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", "response": [ { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the url of the image store", - "name": "url", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -69534,56 +74570,61 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, - {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - } + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {} ], "since": "4.2.0" }, @@ -69602,28 +74643,28 @@ } ], "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} ] }, { @@ -69643,18 +74684,13 @@ "related": "enableOutOfBandManagementForHost,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -69663,36 +74699,31 @@ "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, + {}, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { "description": "the out-of-band management interface username", "name": "username", @@ -69703,12 +74734,22 @@ "name": "driver", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, - {} + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + } ], "since": "4.9.0" }, @@ -69728,35 +74769,24 @@ ], "related": "createProject", "response": [ - {}, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { @@ -69765,44 +74795,106 @@ "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, { "description": "the account name of the project's owners", "name": "owner", "type": "list" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the total volume available for this project", @@ -69810,34 +74902,74 @@ "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" }, { "description": "the date this project was created", @@ -69845,136 +74977,104 @@ "type": "date" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, { "description": "the total number of virtual machines that can be deployed by this project", "name": "vmlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, {}, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total number of buckets stored by this project", + "name": "buckettotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { @@ -69983,44 +75083,55 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the name of the project", - "name": "name", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + {}, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { "description": "the total number of public ip addresses available for this project to acquire", @@ -70028,9 +75139,14 @@ "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" } ], "since": "3.0.0" @@ -70051,16 +75167,74 @@ ], "response": [ {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Prepares management server for maintenance by preventing new jobs from being accepted after completion of active jobs and migrating the agents", + "isasync": false, + "name": "prepareForMaintenance", + "params": [ + { + "description": "indirect agents load balancer algorithm (static, roundrobin, shuffle); when this is not set, already configured algorithm from setting 'indirect.agent.lb.algorithm' is considered", + "length": 255, + "name": "algorithm", + "required": false, "type": "string" }, + { + "description": "Force management server to maintenance after the maintenance window timeout, default is false", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "the id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown,cancelShutdown,readyForShutdown", + "response": [ + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -70068,24 +75242,44 @@ "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + }, + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", "type": "boolean" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" + }, + {}, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" } - ] + ], + "since": "4.21.0" }, { "description": "Delete one or more alerts.", "isasync": false, "name": "deleteAlerts", "params": [ - { - "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, { "description": "the IDs of the alerts", "length": 255, @@ -70094,6 +75288,13 @@ "required": false, "type": "list" }, + { + "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, { "description": "delete by alert type", "length": 255, @@ -70102,20 +75303,16 @@ "type": "string" }, { - "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "enddate", + "name": "startdate", "required": false, "type": "date" } ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -70131,7 +75328,11 @@ "name": "displaytext", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -70140,11 +75341,19 @@ "name": "createAutoScaleVmProfile", "params": [ { - "description": "the template of the auto deployed virtual machine", + "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", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "domain ID of the account owning a autoscale VM profile", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" }, { @@ -70155,14 +75364,6 @@ "required": false, "type": "uuid" }, - { - "description": "availability zone for the auto deployed virtual machine", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "the time allowed for existing connections to get closed before a vm is expunged", "length": 255, @@ -70170,61 +75371,59 @@ "required": false, "type": "integer" }, - { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, { "description": "the ID of the Userdata", "length": 255, "name": "userdataid", - "related": "", + "related": "listCniConfiguration", "required": false, "since": "4.18.1", "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "userdatadetails", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\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\".", + "length": 255, + "name": "otherdeployparams", "required": false, - "since": "4.18.1", "type": "map" }, { - "description": "account that will own the autoscale VM profile", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "account", + "name": "counterparam", "required": false, - "type": "string" + "type": "map" }, { - "description": "domain ID of the account owning a autoscale VM profile", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { - "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", - "length": 1048576, - "name": "userdata", + "description": "account that will own the autoscale VM profile", + "length": 255, + "name": "account", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { "description": "an optional project for the autoscale VM profile", @@ -70235,17 +75434,19 @@ "type": "uuid" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "counterparam", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\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\".", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "otherdeployparams", + "name": "userdatadetails", "required": false, + "since": "4.18.1", "type": "map" } ], @@ -70256,68 +75457,77 @@ "name": "projectid", "type": "string" }, + {}, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, - {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, + {}, { "description": "path of the domain to which the vm profile belongs", "name": "domainpath", "type": "string" }, - {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, - {}, - {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -70326,40 +75536,31 @@ "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, { "description": "the account owning the instance group", "name": "account", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", + "type": "string" }, - { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } + {} ] }, { @@ -70368,16 +75569,16 @@ "name": "registerOauthProvider", "params": [ { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "secretkey", + "name": "clientid", "required": true, "type": "string" }, { - "description": "Description of the OAuth Provider", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "description", + "name": "secretkey", "required": true, "type": "string" }, @@ -70389,9 +75590,9 @@ "type": "string" }, { - "description": "Client ID pre-registered in the specific OAuth provider", + "description": "Description of the OAuth Provider", "length": 255, - "name": "clientid", + "name": "description", "required": true, "type": "string" }, @@ -70411,11 +75612,6 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -70427,6 +75623,11 @@ "name": "success", "type": "boolean" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -70441,18 +75642,11 @@ "isasync": false, "name": "listLBStickinessPolicies", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, "type": "uuid" }, @@ -70463,6 +75657,14 @@ "required": false, "type": "integer" }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "List by keyword", "length": 255, @@ -70471,46 +75673,61 @@ "type": "string" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "", "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the load balancer stickiness policy", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" } ], "related": "createLBStickinessPolicy,updateLBStickinessPolicy", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, + {}, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { @@ -70519,13 +75736,8 @@ "type": "boolean" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { @@ -70537,54 +75749,192 @@ "description": "the state of the policy", "name": "state", "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" } ], "type": "list" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, { "description": "the account of the Stickiness policy", "name": "account", "type": "string" }, - {}, + {} + ], + "since": "3.0.0" + }, + { + "description": "Updates an existing GPU device", + "isasync": false, + "name": "updateGpuDevice", + "params": [ { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "New vGPU profile ID", + "length": 255, + "name": "vgpuprofileid", + "related": "createVgpuProfile,updateVgpuProfile", + "required": false, + "type": "uuid" + }, + { + "description": "New GPU card ID", + "length": 255, + "name": "gpucardid", + "related": "listGpuCards", + "required": false, + "type": "uuid" + }, + { + "description": "New NUMA node of the GPU device", + "length": 255, + "name": "numanode", + "required": false, "type": "string" }, { - "description": "the state of the policy", + "description": "ID of the GPU device to update", + "length": 255, + "name": "id", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "uuid" + }, + { + "description": "New type of GPU device (PCI, MDEV, VGPUOnly)", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "New parent GPU device ID (for virtual GPU devices)", + "length": 255, + "name": "parentgpudeviceid", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": false, + "type": "uuid" + } + ], + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", + "response": [ + { + "description": "the vGPU profile name assigned to this GPU device", "name": "state", + "type": "state" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" + }, + { + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" + }, + { + "description": "the ID of the GPU device", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" + }, + {}, + { + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" + }, + { + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" + }, + { + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], - "since": "3.0.0" + "since": "4.21.0" }, { "description": "Adds a Ucs manager", @@ -70592,25 +75942,17 @@ "name": "addUcsManager", "params": [ { - "description": "the name of UCS manager", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the Zone id for the ucs manager", + "description": "the password of UCS", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the password of UCS", + "description": "the name of UCS manager", "length": 255, - "name": "password", - "required": true, + "name": "name", + "required": false, "type": "string" }, { @@ -70626,27 +75968,29 @@ "name": "url", "required": true, "type": "string" + }, + { + "description": "the Zone id for the ucs manager", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "listUcsManagers", "response": [ - {}, - {}, - { - "description": "the url of ucs manager", - "name": "url", - "type": "string" - }, { "description": "the zone ID of ucs manager", "name": "zoneid", "type": "string" }, { - "description": "the name of ucs manager", - "name": "name", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -70661,7 +76005,13 @@ "description": "the ID of the ucs manager", "name": "id", "type": "string" - } + }, + { + "description": "the name of ucs manager", + "name": "name", + "type": "string" + }, + {} ] }, { @@ -70670,21 +76020,13 @@ "name": "deleteVnfTemplate", "params": [ { - "description": "Force delete a template.", + "description": "Necessary if the template's type is system.", "length": 255, - "name": "forced", + "name": "issystem", "required": false, - "since": "4.9+", + "since": "4.20.0", "type": "boolean" }, - { - "description": "the ID of the template", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" - }, { "description": "the ID of zone of the template", "length": 255, @@ -70694,26 +76036,30 @@ "type": "uuid" }, { - "description": "Necessary if the template's type is system.", + "description": "the ID of the template", "length": 255, - "name": "issystem", + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "Force delete a template.", + "length": 255, + "name": "forced", "required": false, - "since": "4.20.0", + "since": "4.9+", "type": "boolean" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -70724,7 +76070,11 @@ "name": "displaytext", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "4.19.0" }, @@ -70734,19 +76084,18 @@ "name": "listNetscalerLoadBalancers", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -70756,43 +76105,38 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "netscaler load balancer device ID", "length": 255, - "name": "keyword", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "netscaler load balancer device ID", + "description": "the Physical Network ID", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" } ], "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { "description": "true if device is dedicated for an account", @@ -70800,43 +76144,45 @@ "type": "boolean" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, - { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, + {}, { "description": "the management IP address of the external load balancer", "name": "ipaddress", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { @@ -70845,20 +76191,24 @@ "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" } ] }, @@ -70867,13 +76217,6 @@ "isasync": false, "name": "createInstanceGroup", "params": [ - { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the domain ID of account owning the instance group", "length": 255, @@ -70882,6 +76225,13 @@ "required": false, "type": "uuid" }, + { + "description": "the name of the instance group", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "The project of the instance group", "length": 255, @@ -70891,20 +76241,19 @@ "type": "uuid" }, { - "description": "the name of the instance group", + "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" } ], "related": "updateInstanceGroup", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the instance group", + "name": "project", + "type": "string" }, { "description": "the domain name of the instance group", @@ -70912,18 +76261,34 @@ "type": "string" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the ID of the instance group", "name": "id", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { @@ -70932,8 +76297,8 @@ "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { @@ -70941,25 +76306,10 @@ "name": "name", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, {}, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, - { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the instance group", - "name": "project", + "description": "the account owning the instance group", + "name": "account", "type": "string" } ] @@ -70969,34 +76319,6 @@ "isasync": true, "name": "createLoadBalancer", "params": [ - { - "description": "name of the load balancer", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the source port the network traffic will be load balanced from", - "length": 255, - "name": "sourceport", - "required": true, - "type": "integer" - }, - { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", - "length": 255, - "name": "instanceport", - "required": true, - "type": "integer" - }, - { - "description": "the source IP address the network traffic will be load balanced from", - "length": 255, - "name": "sourceipaddress", - "required": false, - "type": "string" - }, { "description": "the description of the load balancer", "length": 4096, @@ -71021,12 +76343,26 @@ "type": "boolean" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "algorithm", + "name": "scheme", "required": true, "type": "string" }, + { + "description": "name of the load balancer", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "length": 255, + "name": "instanceport", + "required": true, + "type": "integer" + }, { "description": "the network id of the source ip address", "length": 255, @@ -71036,62 +76372,133 @@ "type": "uuid" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", + "description": "the source port the network traffic will be load balanced from", "length": 255, - "name": "scheme", + "name": "sourceport", + "required": true, + "type": "integer" + }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", "required": true, "type": "string" + }, + { + "description": "the source IP address the network traffic will be load balanced from", + "length": 255, + "name": "sourceipaddress", + "required": false, + "type": "string" } ], "related": "", "response": [ + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Load Balancer ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, { "description": "the domain ID of the Load Balancer", "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the Load Balancer belongs", - "name": "domainpath", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, + {}, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -71100,85 +76507,47 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" }, { - "description": "the state of the load balancer rule", - "name": "state", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" - }, - { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" } ], "type": "list" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { "description": "the list of instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ + { + "description": "the state of the instance", + "name": "state", + "type": "string" + }, + { + "description": "the name of the instance", + "name": "name", + "type": "string" + }, { "description": "the instance ID", "name": "id", @@ -71188,55 +76557,36 @@ "description": "the ip address of the instance", "name": "ipaddress", "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" }, { - "description": "the state of the instance", + "description": "the state of the load balancer rule", "name": "state", "type": "string" }, { - "description": "the name of the instance", - "name": "name", - "type": "string" + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" } ], "type": "list" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" - }, - {}, { "description": "the account of the Load Balancer", "name": "account", "type": "string" - }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" } ], "since": "4.2.0" @@ -71247,9 +76597,9 @@ "name": "updateBackupSchedule", "params": [ { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "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)", "length": 255, - "name": "intervaltype", + "name": "schedule", "required": true, "type": "string" }, @@ -71257,21 +76607,37 @@ "description": "ID of the VM for which schedule is to be defined", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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", "required": true, "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "timezone", + "name": "intervaltype", "required": true, "type": "string" }, { - "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)", + "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.", "length": 255, - "name": "schedule", + "name": "maxbackups", + "required": false, + "since": "4.21.0", + "type": "integer" + }, + { + "description": "Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.", + "length": 255, + "name": "quiescevm", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", "required": true, "type": "string" } @@ -71279,27 +76645,20 @@ "related": "", "response": [ { - "description": "backup offering name", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "domain id", - "name": "domainid", + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { - "description": "account name", - "name": "account", - "type": "string" + "description": "backup size in bytes", + "name": "size", + "type": "long" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -71311,8 +76670,8 @@ "type": "status" }, { - "description": "external backup id", - "name": "externalid", + "description": "name of the backup", + "name": "name", "type": "string" }, { @@ -71321,29 +76680,54 @@ "type": "date" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "ID of the VM backup", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" + }, + { + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" + }, + { + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, + { + "description": "backup offering id", + "name": "backupofferingid", "type": "string" }, { - "description": "zone id", - "name": "zoneid", + "description": "description for the backup", + "name": "description", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "description": "account name", + "name": "account", + "type": "string" + }, + { + "description": "Interval type of the backup", + "name": "intervaltype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "zone name", @@ -71351,33 +76735,40 @@ "type": "string" }, { - "description": "backup type", - "name": "type", + "description": "account id", + "name": "accountid", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "domain id", + "name": "domainid", + "type": "string" }, { - "description": "backed up volumes", - "name": "volumes", + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "backup type", + "name": "type", "type": "string" }, { - "description": "domain name", - "name": "domain", + "description": "zone id", + "name": "zoneid", "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", + "description": "ID of the VM", + "name": "virtualmachineid", + "type": "string" + }, + {}, + {}, + { + "description": "backed up volumes", + "name": "volumes", "type": "string" } ], @@ -71389,57 +76780,57 @@ "name": "addPaloAltoFirewall", "params": [ { - "description": "supports only PaloAltoFirewall", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "networkdevicetype", + "name": "password", "required": true, "type": "string" }, { - "description": "URL of the Palo Alto appliance.", + "description": "supports only PaloAltoFirewall", "length": 255, - "name": "url", + "name": "networkdevicetype", "required": true, "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "URL of the Palo Alto appliance.", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" } ], "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "response": [ { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the usage interface of the external firewall", + "name": "usageinterface", + "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { @@ -71448,23 +76839,23 @@ "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { @@ -71472,51 +76863,51 @@ "name": "timeout", "type": "string" }, - {}, - {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, + {}, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" } ] @@ -71527,32 +76918,34 @@ "name": "createPrivateGateway", "params": [ { - "description": "the network implementation uri for the private gateway", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "vlan", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IP address of the Private gateaway", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" }, { - "description": "the netmask of the Private gateway", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "netmask", + "name": "ipaddress", "required": true, "type": "string" }, { - "description": "the ID of the network ACL", + "description": "the VPC network belongs to", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, "type": "uuid" }, { @@ -71563,90 +76956,78 @@ "type": "boolean" }, { - "description": "the VPC network belongs to", + "description": "the gateway of the Private gateway", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "gateway", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the gateway of the Private gateway", + "description": "the netmask of the Private gateway", "length": 255, - "name": "gateway", + "name": "netmask", "required": true, "type": "string" }, { - "description": "the Physical Network ID the network belongs to", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "the ID of the network ACL", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "description": "the network implementation uri for the private gateway", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The isolated network this private gateway is associated to.", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "bypassvlanoverlapcheck", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "boolean" } ], "related": "createPrivateGateway,listPrivateGateways", "response": [ { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" - }, - { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, {}, { - "description": "the private gateway's ip address", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the account associated with the private gateway", @@ -71654,54 +77035,58 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", + "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, + { + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" + }, { "description": "ACL name set for private gateway", "name": "aclname", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, - {}, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { @@ -71710,33 +77095,39 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, + {}, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" } ], @@ -71751,29 +77142,29 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, "type": "uuid" } ], "response": [ - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -71786,13 +77177,6 @@ "isasync": false, "name": "uploadSslCert", "params": [ - { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", - "required": false, - "type": "string" - }, { "description": "SSL certificate", "length": 16384, @@ -71800,20 +77184,6 @@ "required": true, "type": "string" }, - { - "description": "Private key", - "length": 16384, - "name": "privatekey", - "required": true, - "type": "string" - }, - { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "Password for the private key", "length": 255, @@ -71829,12 +77199,26 @@ "type": "string" }, { - "description": "Enables revocation checking for certificates", + "description": "an optional project for the SSL certificate", "length": 255, - "name": "enabledrevocationcheck", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" + }, + { + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", + "required": false, + "type": "string" + }, + { + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { "description": "domain ID of the account owning the SSL certificate", @@ -71845,31 +77229,23 @@ "type": "uuid" }, { - "description": "an optional project for the SSL certificate", + "description": "Enables revocation checking for certificates", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "enabledrevocationcheck", "required": false, - "type": "uuid" + "since": "4.15", + "type": "boolean" + }, + { + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, + "type": "string" } ], "related": "", "response": [ - { - "description": "SSL certificate ID", - "name": "id", - "type": "string" - }, - { - "description": "name", - "name": "name", - "type": "string" - }, - { - "description": "certificate chain", - "name": "certchain", - "type": "string" - }, { "description": "certificate fingerprint", "name": "fingerprint", @@ -71881,8 +77257,8 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { @@ -71891,15 +77267,23 @@ "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "the project id of the certificate", + "name": "projectid", + "type": "string" }, - {}, - {}, { - "description": "the project name of the certificate", - "name": "project", + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "name", + "name": "name", "type": "string" }, { @@ -71908,19 +77292,26 @@ "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, + {}, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "certificate chain", + "name": "certchain", "type": "string" + }, + { + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" } ] }, @@ -71930,11 +77321,12 @@ "name": "updateOauthProvider", "params": [ { - "description": "Description of the OAuth Provider", + "description": "id of the OAuth provider to be updated", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" }, { "description": "OAuth provider will be enabled or disabled based on this value", @@ -71944,33 +77336,32 @@ "type": "boolean" }, { - "description": "Client ID pre-registered in the specific OAuth provider", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "clientid", + "name": "secretkey", "required": false, "type": "string" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "Description of the OAuth Provider", "length": 255, - "name": "secretkey", + "name": "description", "required": false, "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "redirecturi", + "name": "clientid", "required": false, "type": "string" }, { - "description": "id of the OAuth provider to be updated", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" + "name": "redirecturi", + "required": false, + "type": "string" } ], "related": "", @@ -71980,53 +77371,53 @@ "name": "secretkey", "type": "string" }, + {}, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { - "description": "Name of the provider", - "name": "name", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" - }, - { - "description": "Description of the provider registered", - "name": "description", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { "description": "Name of the provider", "name": "provider", "type": "string" }, { - "description": "ID of the provider", - "name": "id", + "description": "Name of the provider", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", + "type": "string" + }, + { + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" + }, + {} ], "since": "4.19.0" }, @@ -72036,33 +77427,19 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "If DPD is enabled for VPN connection", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "dpd", + "name": "esplifetime", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "public ip address id of the customer gateway", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "gateway", + "name": "cidrlist", "required": true, "type": "string" }, - { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "esplifetime", - "required": false, - "type": "long" - }, { "description": "Force Encapsulation for NAT traversal", "length": 255, @@ -72080,10 +77457,11 @@ "type": "uuid" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", "length": 255, - "name": "cidrlist", - "required": true, + "name": "ikeversion", + "required": false, + "since": "4.15.1", "type": "string" }, { @@ -72094,19 +77472,19 @@ "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "ikeversion", + "name": "splitconnections", "required": false, "since": "4.15.1", - "type": "string" + "type": "boolean" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "name of this customer gateway", "length": 255, - "name": "ikelifetime", + "name": "name", "required": false, - "type": "long" + "type": "string" }, { "description": "ESP policy of the customer gateway", @@ -72116,25 +77494,38 @@ "type": "string" }, { - "description": "name of this customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "name", + "name": "ikepolicy", + "required": true, + "type": "string" + }, + { + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "ikelifetime", "required": false, + "type": "long" + }, + { + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "splitconnections", + "name": "dpd", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "IKE policy of the customer gateway", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "ikepolicy", - "required": true, + "name": "account", + "required": false, "type": "string" }, { @@ -72149,66 +77540,55 @@ "related": "updateVpnCustomerGateway", "response": [ { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the project name", - "name": "project", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, - {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner", + "name": "account", + "type": "string" }, { "description": "the vpn gateway ID", @@ -72216,59 +77596,70 @@ "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the project id", - "name": "projectid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" + }, + { + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" } ] }, @@ -72278,20 +77669,28 @@ "name": "addBaremetalHost", "params": [ { - "description": "the Pod ID for the host", + "description": "the Zone ID for the host", "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "hypervisor type of the host", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "hypervisor", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, + { + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, { "description": "ip address intentionally allocated to this host after provisioning", "length": 255, @@ -72299,6 +77698,22 @@ "required": false, "type": "string" }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "comma separated list of storage access groups for the host", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" + }, { "description": "the host URL", "length": 255, @@ -72307,11 +77722,11 @@ "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "the cluster name for the host", "length": 255, - "name": "hosttags", + "name": "clustername", "required": false, - "type": "list" + "type": "string" }, { "description": "the cluster ID for the host", @@ -72322,34 +77737,26 @@ "type": "uuid" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "hypervisor type of the host", "length": 255, - "name": "username", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "list of tags to be added to the host", "length": 255, - "name": "allocationstate", + "name": "hosttags", "required": false, - "type": "string" + "type": "list" }, { - "description": "the cluster name for the host", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "clustername", + "name": "username", "required": false, "type": "string" }, - { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, @@ -72360,56 +77767,76 @@ ], "related": "declareHostAsDegraded,listHosts,reconnectHost", "response": [ - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, { "description": "the state of the host", "name": "state", "type": "status" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, - {}, { "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", "name": "suitableformigration", "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + {}, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { "description": "capabilities of the host", @@ -72417,55 +77844,210 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { "description": "the cluster ID of the host", "name": "clusterid", "type": "string" }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, { "description": "the last time this host was annotated", "name": "lastannotated", "type": "date" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -72479,11 +78061,21 @@ "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, { "description": "Maximum Y resolution per display", "name": "maxresolutiony", "type": "long" }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, { "description": "Maximum X resolution per display", "name": "maxresolutionx", @@ -72499,11 +78091,6 @@ "name": "maxvgpuperpgpu", "type": "long" }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, { "description": "Model Name of vGPU", "name": "vgputype", @@ -72513,11 +78100,6 @@ "description": "Video RAM for this vGPU type", "name": "videoram", "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" } ], "type": "list" @@ -72526,58 +78108,23 @@ "type": "list" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { @@ -72586,53 +78133,24 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, + {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { @@ -72641,14 +78159,14 @@ "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { "description": "true if the host supports encryption", @@ -72656,50 +78174,10 @@ "type": "boolean" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, {}, { "description": "the date and time the host was removed", @@ -72707,48 +78185,28 @@ "type": "date" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" } ] @@ -72768,36 +78226,36 @@ ], "related": "addAnnotation,listAnnotations", "response": [ - {}, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, + {}, + {}, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { @@ -72805,29 +78263,29 @@ "name": "removed", "type": "date" }, - { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, { "description": "the (uu)id of the entity to which this annotation pertains", "name": "entityid", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" } ], @@ -72848,28 +78306,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "4.20.0" }, @@ -72895,11 +78353,6 @@ "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -72909,721 +78362,1053 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.9.0" }, { - "description": "Update VM Schedule.", - "isasync": false, - "name": "updateVMSchedule", + "description": "Creates and automatically starts a VM from a backup.", + "isasync": true, + "name": "createVMFromBackup", "params": [ { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "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.", "length": 255, - "name": "enddate", + "name": "iothreadsenabled", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "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", "length": 255, - "name": "schedule", + "name": "datadisksdetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "Name of the schedule", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "description", + "name": "affinitygroupids", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "string" + "type": "list" }, { - "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "startdate", + "name": "bootintosetup", "required": false, - "type": "date" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "Enable VM schedule", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "enabled", + "name": "displayname", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "host name for the virtual machine", "length": 255, - "name": "timezone", + "name": "name", "required": false, "type": "string" }, { - "description": "ID of VM schedule", + "description": "Deploy vm for the project", "length": 255, - "name": "id", - "related": "updateVMSchedule", - "required": true, + "name": "projectid", + "related": "createProject", + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "the ip address for default vm's network", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "length": 255, + "name": "securitygroupnames", + "related": "updateSecurityGroup", + "required": false, + "type": "list" + }, + { + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", "type": "string" }, - {}, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": false, + "since": "4.21", + "type": "uuid" }, { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "The number of queues for multiqueue NICs.", + "length": 255, + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" }, { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" + "description": "backup ID to create the VM from", + "length": 255, + "name": "backupid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "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", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "since": "4.11", + "type": "map" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.2", + "type": "boolean" + }, + { + "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.", + "length": 255, + "name": "bootmode", + "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists all configuration groups (primarily used for UI).", - "isasync": false, - "name": "listConfigurationGroups", - "params": [ + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { - "description": "", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", "length": 255, - "name": "pagesize", + "name": "affinitygroupnames", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "integer" + "type": "list" }, { - "description": "", + "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", "length": 255, - "name": "page", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists configuration group by group name", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "group", + "name": "customid", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "used to specify the vApp properties.", "length": 255, - "name": "keyword", + "name": "properties", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "since": "4.15", + "type": "map" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the configuration group", - "name": "name", + "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.", + "length": 255, + "name": "boottype", + "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "the subgroups of the configuration group", - "name": "subgroup", - "response": [ - { - "description": "the precedence of the configuration subgroup", - "name": "precedence", - "type": "long" - }, - { - "description": "the name of the configuration subgroup", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" }, { - "description": "the description of the configuration group", - "name": "description", + "description": "an optional group for the virtual machine", + "length": 255, + "name": "group", + "required": false, "type": "string" }, { - "description": "the precedence of the configuration group", - "name": "precedence", - "type": "long" + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" }, - {}, - {} - ], - "since": "4.18.0" - }, - { - "description": "Releases a Pod IP back to the Pod", - "isasync": false, - "name": "releasePodIpAddress", - "params": [ { - "description": "UUID of the Pod IP", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "id", - "required": true, - "type": "long" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if start vm after creating; defaulted to true if not specified", + "length": 255, + "name": "startvm", + "required": false, + "type": "boolean" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Updates remote access vpn", - "isasync": true, - "name": "updateRemoteAccessVpn", - "params": [ + "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.", + "length": 255, + "name": "preserveip", + "required": false, + "type": "boolean" + }, { - "description": "id of the remote access vpn", + "description": "the ID of the Userdata", "length": 255, - "name": "id", - "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", - "required": true, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.18", "type": "uuid" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "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", "length": 255, - "name": "fordisplay", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "customid", + "name": "leaseexpiryaction", "required": false, - "since": "4.4", + "since": "4.21.0", "type": "string" - } - ], - "related": "createRemoteAccessVpn,listRemoteAccessVpns", - "response": [ + }, { - "description": "the public ip address of the vpn server", - "name": "publicip", - "type": "string" + "description": "Number of days instance is leased for.", + "length": 255, + "name": "leaseduration", + "required": false, + "since": "4.21.0", + "type": "integer" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "length": 255, + "name": "details", + "required": false, + "since": "4.3", + "type": "map" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" + "description": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "length": 255, + "name": "networkids", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "list" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", - "type": "string" + "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", + "length": 255, + "name": "iptonetworklist", + "required": false, + "type": "map" }, { - "description": "the state of the rule", - "name": "state", + "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", + "length": 255, + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" + }, + { + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "length": 255, + "name": "password", + "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.4", + "type": "long" }, - {}, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" + "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.", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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", + "length": 255, + "name": "overridediskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "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", + "length": 255, + "name": "securitygroupids", + "related": "updateSecurityGroup", + "required": false, + "type": "list" }, - {}, { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "since": "4.21", + "type": "uuid" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", + "required": false, "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", - "isasync": true, - "name": "destroyVirtualMachine", - "params": [ + }, { - "description": "Comma separated list of UUIDs for volumes that will be deleted", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "volumeids", - "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "nicpackedvirtqueuesenabled", "required": false, - "since": "4.12.0", - "type": "list" + "since": "4.18", + "type": "boolean" }, { - "description": "If true is passed, the vm is expunged immediately. False by default.", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", "length": 255, - "name": "expunge", + "name": "keyboard", "required": false, - "since": "4.2.1", - "type": "boolean" + "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" + "name": "copyimagetags", + "required": false, + "since": "4.13", + "type": "boolean" + }, + { + "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", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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": [ { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the account associated with the tag", + "name": "account", "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" } ], "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + {}, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, { "description": "an alternate display text of the ISO attached to the virtual machine", "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "Base64 string representation of the resource icon", @@ -73631,8 +79416,38 @@ "type": "resourceiconresponse" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -73640,69 +79455,58 @@ "name": "vnfnics", "type": "list" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", @@ -73714,8 +79518,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -73724,13 +79528,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -73744,44 +79553,22 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ + }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { "description": "the starting IP of the security group rule", @@ -73789,167 +79576,80 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], @@ -73961,13 +79661,13 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -73981,778 +79681,1098 @@ "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - {}, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" - } - ], - "type": "set" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "the description of the affinity group", - "name": "description", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" } ], "type": "set" + } + ], + "since": "4.21.0" + }, + { + "description": "Update VM Schedule.", + "isasync": false, + "name": "updateVMSchedule", + "params": [ + { + "description": "Name of the schedule", + "length": 255, + "name": "description", + "required": false, + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "updateVMSchedule", + "required": true, + "type": "uuid" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", + "required": false, "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "Enable VM schedule", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "length": 255, + "name": "schedule", + "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - } - ] - }, - { - "description": "Assigns a VM to a backup offering", - "isasync": true, - "name": "assignVirtualMachineToBackupOffering", - "params": [ + "description": "Action", + "name": "action", + "type": "action" + }, { - "description": "ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { - "description": "ID of the backup offering", - "length": 255, - "name": "backupofferingid", - "related": "listBackupOfferings,updateBackupOffering", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + {}, + { + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" } ], - "since": "4.14.0" + "since": "4.19.0" }, { - "description": "Starts a virtual machine.", - "isasync": true, - "name": "startVirtualMachine", + "description": "Lists all configuration groups (primarily used for UI).", + "isasync": false, + "name": "listConfigurationGroups", "params": [ { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, - { - "description": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - }, - { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "List by keyword", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "keyword", "required": false, - "since": "3.0.1", - "type": "uuid" + "type": "string" }, { - "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "description": "lists configuration group by group name", "length": 255, - "name": "considerlasthost", + "name": "group", "required": false, - "since": "4.18.0", - "type": "boolean" + "type": "string" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "", "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "", "length": 255, - "name": "deploymentplanner", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "", "response": [ { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the name of the configuration group", + "name": "name", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the description of the configuration group", + "name": "description", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the precedence of the configuration group", + "name": "precedence", "type": "long" }, + {}, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the subgroups of the configuration group", + "name": "subgroup", + "response": [ + { + "description": "the name of the configuration subgroup", + "name": "name", + "type": "string" + }, + { + "description": "the precedence of the configuration subgroup", + "name": "precedence", + "type": "long" + } + ], + "type": "list" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.18.0" + }, + { + "description": "Releases a Pod IP back to the Pod", + "isasync": false, + "name": "releasePodIpAddress", + "params": [ { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, + "description": "UUID of the Pod IP", + "length": 255, + "name": "id", + "required": true, + "type": "long" + } + ], + "response": [ { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, + {} + ] + }, + { + "description": "Updates remote access vpn", + "isasync": true, + "name": "updateRemoteAccessVpn", + "params": [ { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "id of the remote access vpn", + "length": 255, + "name": "id", + "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", + "required": true, + "type": "uuid" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "createRemoteAccessVpn,listRemoteAccessVpns", + "response": [ { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ipsec preshared key", + "name": "presharedkey", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ + "description": "the state of the rule", + "name": "state", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "Lists all available GPU devices", + "isasync": false, + "name": "listGpuDevices", + "params": [ + { + "description": "the virtual machine ID to which the GPU device is allocated", + "length": 255, + "name": "virtualmachineid", + "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", + "required": false, + "type": "uuid" + }, + { + "description": "the host ID where the GPU device is attached", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the vGPU profile ID assigned to the GPU device", + "length": 255, + "name": "vgpuprofileid", + "related": "createVgpuProfile,updateVgpuProfile", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the GPU card ID associated with the GPU device", + "length": 255, + "name": "gpucardid", + "related": "listGpuCards", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "ID of the GPU device", + "length": 255, + "name": "id", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", + "required": false, + "type": "uuid" + } + ], + "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", + "response": [ + { + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" + }, + { + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", + "type": "string" + }, + {}, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" + }, + { + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the GPU device", + "name": "id", + "type": "string" + }, + { + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the NUMA node where the GPU device is located", + "name": "numanode", + "type": "string" + }, + { + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" + } + ], + "since": "4.21.0" + }, + { + "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", + "isasync": true, + "name": "destroyVirtualMachine", + "params": [ + { + "description": "If true is passed, the vm is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.2.1", + "type": "boolean" + }, + { + "description": "Comma separated list of UUIDs for volumes that will be deleted", + "length": 255, + "name": "volumeids", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "since": "4.12.0", + "type": "list" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "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", + "required": true, + "type": "uuid" + } + ], + "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": [ + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the project name of the group", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -74766,128 +80786,31 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", @@ -74897,78 +80820,43 @@ "name": "ruleid", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -74977,13 +80865,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -74995,209 +80878,212 @@ "description": "the project name where tag belongs to", "name": "project", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain name of the security group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - {}, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "the write (IO) of disk on the VM", @@ -75205,33 +81091,33 @@ "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -75240,225 +81126,216 @@ "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + {}, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the ID of the corresponding network", @@ -75466,8 +81343,8 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -75476,19 +81353,19 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { "description": "the isolation uri of the nic", @@ -75501,33 +81378,53 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -75536,67 +81433,97 @@ "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, - {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -75605,766 +81532,519 @@ "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - } - ] - }, - { - "description": "Lists the resource icon for the specified resource(s)", - "isasync": false, - "name": "listResourceIcon", - "params": [ - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - } - ], - "related": "", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, - {}, { - "description": "base64 representation of resource icon", - "name": "base64image", - "type": "string" - } - ], - "since": "4.16.0.0" - }, - { - "description": "Creates a new Pod.", - "isasync": false, - "name": "createPod", - "params": [ + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "the gateway for the Pod", - "length": 255, - "name": "gateway", - "required": false, - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "Allocation state of this Pod for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the netmask for the Pod", - "length": 255, - "name": "netmask", - "required": false, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ending IP address for the Pod", - "length": 255, - "name": "endip", - "required": false, - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the Pod", - "length": 255, - "name": "name", - "required": true, + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the starting IP address for the Pod", - "length": 255, - "name": "startip", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" - } - ], - "related": "listPods,createManagementNetworkIpRange", - "response": [ + }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the name of the Pod", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, - {}, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - } - ], - "type": "list" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - } - ], - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } ] }, { - "description": "Safely removes raw records from cloud_usage table", - "isasync": false, - "name": "removeRawUsageRecords", + "description": "Assigns a VM to a backup offering", + "isasync": true, + "name": "assignVirtualMachineToBackupOffering", "params": [ { - "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today", + "description": "ID of the backup offering", "length": 255, - "name": "interval", + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", "required": true, - "type": "integer" + "type": "uuid" + }, + { + "description": "ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "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", + "required": true, + "type": "uuid" } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], - "since": "4.6.0" + "since": "4.14.0" }, { - "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", + "description": "Starts a virtual machine.", "isasync": true, - "name": "provisionCertificate", + "name": "startVirtualMachine", "params": [ { - "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "required": true, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { - "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "reconnect", + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "The ID of the virtual machine", "length": 255, - "name": "provider", - "required": false, - "type": "string" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "name": "id", + "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", + "required": true, + "type": "uuid" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Lists VM metrics", - "isasync": false, - "name": "listVirtualMachinesMetrics", - "params": [ { - "description": "list by the service offering", + "description": "Boot into hardware setup menu or not", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "bootintosetup", "required": false, - "since": "4.4", - "type": "uuid" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "the group ID", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "groupid", - "related": "updateInstanceGroup", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, + "since": "3.0.1", "type": "uuid" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "deploymentplanner", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "the ID of AutoScaling VM Group", + "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup", + "name": "considerlasthost", "required": false, "since": "4.18.0", - "type": "uuid" - }, + "type": "boolean" + } + ], + "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": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "comma separated list of vm 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.", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": false, - "since": "4.4", - "type": "list" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "uuid" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", - "length": 255, - "name": "haenable", - "required": false, - "since": "4.15", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "flag to display the resource icon for VMs", - "length": 255, - "name": "showicon", - "required": false, - "since": "4.16.0.0", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "updateSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "list by the backup offering", - "length": 255, - "name": "backupofferingid", - "related": "listBackupOfferings,updateBackupOffering", - "required": false, - "since": "4.17", - "type": "uuid" - }, - { - "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.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, + {}, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": false, - "type": "uuid" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "list vms by template", - "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": false, - "type": "uuid" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "list vms by iso", - "length": 255, - "name": "isoid", - "required": false, - "type": "uuid" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", - "length": 255, - "name": "state", - "required": false, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the storage ID where vm's volumes belong to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "CPU arch of the VM", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20.1", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "type": "uuid" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the pod ID", - "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "list vms by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "uuid" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": false, - "type": "uuid" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.4", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", - "length": 255, - "name": "userdata", - "required": false, - "since": "4.18.0.0", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "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.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the instances by userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.20.1", - "type": "uuid" - } - ], - "related": "listVirtualMachinesMetrics", - "response": [ - { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -76373,192 +82053,262 @@ "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" } ], "type": "set" }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" - }, {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "disk read in MiB", - "name": "diskread", - "type": "string" - }, - { - "description": "network write in MiB", - "name": "networkwrite", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { "description": "the incoming network traffic on the VM in KiB", @@ -76566,212 +82316,235 @@ "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, { "description": "device type of the root volume", "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - {}, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, { "description": "the VM's disk write in KiB", "name": "diskkbswrite", "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -76779,28 +82552,43 @@ "name": "ruleid", "type": "string" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -76814,43 +82602,28 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -76860,42 +82633,37 @@ "description": "the protocol of the security group rule", "name": "protocol", "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -76903,38 +82671,38 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -76943,52 +82711,62 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" @@ -76999,335 +82777,984 @@ "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the description of the security group", - "name": "description", + "description": "the account owning the security group", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" - }, + } + ] + }, + { + "description": "Lists the resource icon for the specified resource(s)", + "isasync": false, + "name": "listResourceIcon", + "params": [ { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "network read in MiB", - "name": "networkread", + "description": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "resource type", + "name": "resourcetype", + "type": "resourceobjecttype" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "base64 representation of resource icon", + "name": "base64image", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + {} + ], + "since": "4.16.0.0" + }, + { + "description": "Creates a new Pod.", + "isasync": false, + "name": "createPod", + "params": [ + { + "description": "the name of the Pod", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the gateway for the Pod", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this Pod for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "the netmask for the Pod", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, + { + "description": "the starting IP address for the Pod", + "length": 255, + "name": "startip", + "required": false, + "type": "string" + }, + { + "description": "the Zone ID in which the Pod will be created", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "comma separated list of storage access groups for the hosts in the pod", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" + }, + { + "description": "the ending IP address for the Pod", + "length": 255, + "name": "endip", + "required": false, + "type": "string" + } + ], + "related": "listPods,createManagementNetworkIpRange", + "response": [ + {}, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" + }, + {}, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", "name": "vlanid", - "type": "integer" + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + } + ] + }, + { + "description": "Safely removes raw records from cloud_usage table", + "isasync": false, + "name": "removeRawUsageRecords", + "params": [ + { + "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today", + "length": 255, + "name": "interval", + "required": true, + "type": "integer" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.6.0" + }, + { + "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", + "isasync": true, + "name": "provisionCertificate", + "params": [ + { + "description": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", + "length": 255, + "name": "reconnect", + "required": false, + "type": "boolean" + }, + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11.0" + }, + { + "description": "Lists VM metrics", + "isasync": false, + "name": "listVirtualMachinesMetrics", + "params": [ + { + "description": "the instances by userdata", + "length": 255, + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.20.1", + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "length": 255, + "name": "userdata", + "required": false, + "since": "4.18.0.0", + "type": "boolean" + }, + { + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "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.", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of AutoScaling VM Group", + "length": 255, + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup", + "required": false, + "since": "4.18.0", + "type": "uuid" + }, + { + "description": "The ID of the Orchestrator extension for the VM", + "length": 255, + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" + }, + { + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "updateInstanceGroup", + "required": false, + "type": "uuid" + }, + { + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the storage ID where vm's volumes belong to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "flag to display the resource icon for VMs", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.16.0.0", + "type": "boolean" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the user ID that created the VM and is under the account that owns the VM", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "comma separated list of vm 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.", + "length": 255, + "name": "details", + "required": false, + "type": "list" + }, + { + "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "length": 255, + "name": "accumulate", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, + { + "description": "list vms by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" + }, + { + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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.", + "length": 255, + "name": "gpuenabled", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "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", + "required": false, + "since": "4.4", + "type": "list" + }, + { + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "list by the service offering", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "CPU arch of the VM", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20.1", + "type": "string" + }, + { + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "length": 255, + "name": "haenable", + "required": false, + "since": "4.15", + "type": "boolean" + }, + { + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "Whether to return only leased instances", + "length": 255, + "name": "leased", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "list by the backup offering", + "length": 255, + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "the security group ID", + "length": 255, + "name": "securitygroupid", + "related": "updateSecurityGroup", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the host ID", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "list vms by template", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "id", + "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", + "required": false, + "type": "uuid" + } + ], + "related": "listVirtualMachinesMetrics", + "response": [ + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -77335,133 +83762,1167 @@ "name": "traffictype", "type": "string" }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, { "description": "Id of the vpc to which the nic belongs", "name": "vpcid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "network read in MiB", + "name": "networkread", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the total memory capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "resource type", + "name": "resourcetype", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "network write in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + {}, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "disk write in MiB", + "name": "diskwrite", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + {}, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "disk read in MiB", + "name": "diskread", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + {}, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, { "description": "Guest vm Boot Type", "name": "boottype", "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -77471,27 +84932,18 @@ "name": "listHosts", "params": [ { - "description": "CPU Arch of the host", + "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", "length": 255, - "name": "arch", + "name": "resourcestate", "required": false, - "since": "4.20.1", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { "description": "lists hosts existing in particular cluster", @@ -77502,25 +84954,28 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the state of the host", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "CPU Arch of the host", "length": 255, - "name": "hahost", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20.1", + "type": "string" }, { - "description": "the host type", + "description": "the id of the management server", "length": 255, - "name": "type", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", @@ -77530,33 +84985,26 @@ "type": "list" }, { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "List by keyword", "length": 255, - "name": "resourcestate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the state of the host", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "state", + "name": "virtualmachineid", + "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", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "", "length": 255, - "name": "outofbandmanagementenabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", @@ -77566,16 +85014,16 @@ "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "hypervisor", + "name": "hahost", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the host", + "description": "the host type", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, @@ -77588,10 +85036,10 @@ "type": "uuid" }, { - "description": "the Pod ID for the host", + "description": "the Zone ID for the host", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -77601,39 +85049,73 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the host", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list hosts for which out-of-band management is enabled", + "length": 255, + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", + "type": "string" } ], "related": "declareHostAsDegraded,reconnectHost", "response": [ { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, - {}, { - "description": "the name of the host", - "name": "name", + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { @@ -77642,18 +85124,49 @@ "type": "double" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, + {}, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { @@ -77662,83 +85175,187 @@ "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { "description": "comma-separated list of tags for the host", "name": "hosttags", "type": "string" }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, { "description": "the host type", "name": "type", "type": "type" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { @@ -77747,154 +85364,119 @@ "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, { "description": "Whether the informed tag is a JS interpretable rule or not.", "name": "istagarule", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, - {}, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, + {}, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { @@ -77903,97 +85485,44 @@ "type": "date" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the host version", + "name": "version", "type": "string" } ] @@ -78003,6 +85532,13 @@ "isasync": false, "name": "deleteStoragePool", "params": [ + { + "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "Storage pool id", "length": 255, @@ -78010,38 +85546,31 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" - }, - { - "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -78060,9 +85589,14 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -78072,14 +85606,9 @@ {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.17.0.0" @@ -78090,241 +85619,251 @@ "name": "updateStoragePool", "params": [ { - "description": "the details for the storage pool", + "description": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, - "name": "details", + "name": "enabled", "required": false, - "since": "4.19.0", - "type": "map" + "type": "boolean" }, { - "description": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "enabled", + "name": "istagarule", "required": false, "type": "boolean" }, { - "description": "Change the name of the storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "name", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "capacityiops", "required": false, - "since": "4.15", - "type": "string" + "type": "long" }, { - "description": "the URL of the storage pool", + "description": "the Id of the storage pool", "length": 255, - "name": "url", - "required": false, - "since": "4.19.0", - "type": "string" + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "istagarule", + "name": "capacitybytes", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "comma-separated list of tags for the storage pool", + "description": "the details for the storage pool", "length": 255, - "name": "tags", + "name": "details", "required": false, - "type": "list" + "since": "4.19.0", + "type": "map" }, { - "description": "the Id of the storage pool", + "description": "Change the name of the storage pool", "length": 255, - "name": "id", + "name": "name", "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "required": false, + "since": "4.15", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "comma-separated list of tags for the storage pool", "length": 255, - "name": "capacityiops", + "name": "tags", "required": false, - "type": "long" + "type": "list" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "the URL of the storage pool", "length": 255, - "name": "capacitybytes", + "name": "url", "required": false, - "type": "long" + "since": "4.19.0", + "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, { "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, - {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { "description": "the scope of the storage pool", "name": "scope", "type": "string" }, - {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" } ], @@ -78336,18 +85875,25 @@ "name": "listBackupRepositories", "params": [ { - "description": "name of the backup repository", + "description": "", "length": 255, - "name": "name", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the backup repository provider", "length": 255, - "name": "page", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { "description": "ID of the backup repository", @@ -78358,12 +85904,11 @@ "type": "uuid" }, { - "description": "ID of the zone where the backup repository is to be added", + "description": "name of the backup repository", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -78373,43 +85918,36 @@ "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the backup repository provider", + "description": "ID of the zone where the backup repository is to be added", "length": 255, - "name": "provider", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "addBackupRepository", "response": [ - {}, { - "description": "the ID of the backup repository", - "name": "id", - "type": "string" + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "backup type", + "name": "type", + "type": "string" }, { "description": "the Zone ID of the backup repository", "name": "zoneid", "type": "string" }, + {}, { - "description": "capacity of the backup repository", - "name": "capacitybytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the Zone name of the backup repository", @@ -78417,18 +85955,18 @@ "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the ID of the backup repository", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" }, { - "description": "the address / url of the backup repository", - "name": "address", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -78437,15 +85975,16 @@ "type": "string" }, { - "description": "the date and time the backup repository was added", - "name": "created", - "type": "date" + "description": "the address / url of the backup repository", + "name": "address", + "type": "string" }, { - "description": "backup type", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.20.0" }, @@ -78455,23 +85994,24 @@ "name": "listTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "applicationpolicysetuuid", + "name": "vmuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric nic", + "description": "the ID of zone", "length": 255, - "name": "nicuuid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "networkuuid", + "name": "taguuid", "required": false, "type": "string" }, @@ -78483,92 +86023,71 @@ "type": "integer" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "pagesize", + "name": "nicuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "List by keyword", "length": 255, - "name": "policyuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "taguuid", + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "keyword", + "name": "policyuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric vm", + "description": "", "length": 255, - "name": "vmuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "applicationpolicysetuuid", "required": false, - "type": "uuid" + "type": "string" } ], "related": "applyTungstenFabricTag", "response": [ - { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" - }, - {}, { "description": "list Tungsten-Fabric policy", "name": "policy", "type": "list" }, - { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" - }, - {}, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { "description": "Tungsten-Fabric provider zone id", @@ -78579,6 +86098,26 @@ "description": "list Tungsten-Fabric nic", "name": "nic", "type": "list" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" + }, + { + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, @@ -78595,16 +86134,9 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", + "description": "List by keyword", "length": 255, - "name": "group", + "name": "keyword", "required": false, "type": "string" }, @@ -78616,46 +86148,53 @@ "type": "string" }, { - "description": "details for account used to store specific parameters", + "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain", "length": 255, - "name": "accountdetails", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "Creates the account under the specified role.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "", "length": 255, - "name": "accounttype", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.", "length": 255, - "name": "page", + "name": "group", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain", + "description": "details for account used to store specific parameters", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "accountdetails", + "required": false, + "type": "map" + }, + { + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, "type": "uuid" } @@ -78663,40 +86202,40 @@ "related": "searchLdap", "response": [ { - "description": "The user's principle", - "name": "principal", + "description": "The user's domain", + "name": "domain", "type": "string" }, + {}, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's username", + "name": "username", "type": "string" }, + {}, { "description": "The user's email", "name": "email", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's principle", + "name": "principal", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The user's username", - "name": "username", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { @@ -78705,9 +86244,9 @@ "type": "string" }, { - "description": "The user's domain", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.3.0" @@ -78737,34 +86276,43 @@ "related": "createDomain,listDomains,listDomains", "response": [ { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, - {}, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of backups stored by this domain", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { @@ -78772,19 +86320,54 @@ "name": "volumelimit", "type": "string" }, + { + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" + }, { "description": "the total secondary storage space (in GiB) owned by domain", "name": "secondarystoragetotal", "type": "float" }, + { + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" + }, { "description": "the level of the domain", "name": "level", "type": "integer" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { @@ -78793,59 +86376,63 @@ "type": "long" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, - {}, { - "description": "the state of the domain", - "name": "state", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { @@ -78854,149 +86441,176 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the path of the domain", - "name": "path", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, { "description": "the total number of public ip addresses available for this domain to acquire", "name": "ipavailable", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", + "type": "string" }, + {}, { "description": "the total number of virtual machines available for this domain to acquire", "name": "vmavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, + {}, { "description": "the name of the domain", "name": "name", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" } ], "since": "4.19.0.0" @@ -79006,6 +86620,21 @@ "isasync": false, "name": "listNetworks", "params": [ + { + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, { "description": "list networks by network offering ID", "length": 255, @@ -79015,19 +86644,29 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared).", "length": 255, - "name": "keyword", + "name": "networkfilter", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "list networks available for VM deployment", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "canusefordeploy", + "name": "displaynetwork", "required": false, + "since": "4.4", "type": "boolean" }, + { + "description": "list networks by ID", + "length": 255, + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, { "description": "true if network is system, false otherwise", "length": 255, @@ -79036,11 +86675,11 @@ "type": "boolean" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "the network belongs to VPC", "length": 255, - "name": "acltype", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -79050,63 +86689,64 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List networks by VPC", "length": 255, - "name": "account", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "list networks by restartRequired", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "restartrequired", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List networks by VPC", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "acltype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "page", + "name": "specifyipranges", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list networks by ID", + "description": "the ID or VID of the network", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "vlan", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "string" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "type of the traffic", "length": 255, - "name": "specifyipranges", + "name": "traffictype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "type of the traffic", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "traffictype", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "makes the API's response contains only the resource count", @@ -79116,12 +86756,11 @@ "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "displaynetwork", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -79132,16 +86771,16 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "tags", + "name": "type", "required": false, - "type": "map" + "type": "string" }, { - "description": "the network belongs to VPC", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "forvpc", + "name": "showicon", "required": false, "type": "boolean" }, @@ -79154,35 +86793,11 @@ "type": "uuid" }, { - "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared).", - "length": 255, - "name": "networkfilter", - "required": false, - "since": "4.17.0", - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "List networks by associated networks. Only available if create a Shared network.", + "description": "list networks available for VM deployment", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "canusefordeploy", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "boolean" }, { "description": "the zone ID of the network", @@ -79193,11 +86808,11 @@ "type": "uuid" }, { - "description": "flag to display the resource icon for networks", + "description": "", "length": 255, - "name": "showicon", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list networks supporting certain services", @@ -79207,61 +86822,25 @@ "type": "list" }, { - "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.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID or VID of the network", + "description": "list networks by restartRequired", "length": 255, - "name": "vlan", + "name": "restartrequired", "required": false, - "since": "4.17.0", - "type": "string" + "type": "boolean" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { @@ -79270,145 +86849,95 @@ "type": "map" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the owner of the network", - "name": "account", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, { "description": "The vlan of the network. This parameter is visible to ROOT admins only", "name": "vlan", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the id of the network", - "name": "id", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, + {}, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "state of the network", @@ -79416,43 +86945,43 @@ "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, { "description": "MTU configured on the network VR's public facing interfaces", "name": "publicmtu", "type": "integer" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the owner of the network", + "name": "account", "type": "string" }, { @@ -79460,23 +86989,40 @@ "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { "description": "state of the network provider", @@ -79484,41 +87030,24 @@ "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the capability name", + "description": "the provider name", "name": "name", "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" } ], "type": "list" @@ -79532,13 +87061,13 @@ "type": "list" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { @@ -79546,23 +87075,23 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -79571,106 +87100,182 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, + {}, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", + "name": "ip6routes", "type": "set" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { @@ -79679,85 +87284,84 @@ "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, { "description": "The external id of the network", "name": "externalid", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the name of the Network associated with this network", + "description": "the name of the Network associated with this private gateway", "name": "associatednetwork", "type": "string" - }, - {}, - { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" } ] }, @@ -79776,27 +87380,27 @@ } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.17" @@ -79829,13 +87433,6 @@ "required": true, "type": "string" }, - { - "description": "The new starting IP address.", - "length": 255, - "name": "newstartip", - "required": false, - "type": "string" - }, { "description": "UUID of POD, where the IP range belongs to.", "length": 255, @@ -79843,99 +87440,138 @@ "related": "listPods,createManagementNetworkIpRange", "required": true, "type": "uuid" + }, + { + "description": "The new starting IP address.", + "length": 255, + "name": "newstartip", + "required": false, + "type": "string" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.16.0.0" }, { - "description": "Updates firewall rule ", - "isasync": true, - "name": "updateFirewallRule", + "description": "Adds a new OS category", + "isasync": false, + "name": "addOsCategory", "params": [ { - "description": "the ID of the firewall rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Whether the category is featured or not", "length": 255, - "name": "customid", + "name": "isfeatured", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Name of the OS category", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "name", + "required": true, + "type": "string" } ], - "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", + "related": "listOsCategories", "response": [ + {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the name of the OS category", + "name": "name", "type": "string" }, + { + "description": "Whether the OS category is featured", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the firewall rule", + "description": "the ID of the OS category", "name": "id", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" }, + {} + ], + "since": "4.21.0" + }, + { + "description": "Updates firewall rule ", + "isasync": true, + "name": "updateFirewallRule", + "params": [ { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", + "response": [ + { + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { @@ -79944,13 +87580,8 @@ "type": "integer" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { @@ -79959,33 +87590,48 @@ "type": "integer" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", "name": "destcidrlist", "type": "string" }, + {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -79994,13 +87640,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -80008,45 +87654,65 @@ "name": "project", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, - {} + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + {}, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + } ], "since": "4.4" }, @@ -80055,25 +87721,25 @@ "isasync": false, "name": "quotaIsEnabled", "params": [], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, + "related": "", + "response": [ {}, { "description": "is quota service enabled", "name": "isenabled", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.7.0" }, @@ -80097,8 +87763,6 @@ "name": "success", "type": "boolean" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -80113,7 +87777,9 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {}, + {} ], "since": "4.19.0" }, @@ -80122,17 +87788,10 @@ "isasync": false, "name": "quotaEmailTemplateList", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -80146,24 +87805,30 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "The quota email template locale", - "name": "locale", - "type": "string" + "description": "Last date/time when template was updated", + "name": "last_updated", + "type": "date" }, { - "description": "Template type", - "name": "templatetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -80171,9 +87836,9 @@ }, {}, { - "description": "Last date/time when template was updated", - "name": "last_updated", - "type": "date" + "description": "The quota email template locale", + "name": "locale", + "type": "string" }, { "description": "The quota email template subject", @@ -80181,10 +87846,11 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Template type", + "name": "templatetype", "type": "string" }, + {}, { "description": "The quota email template content", "name": "templatebody", @@ -80198,22 +87864,6 @@ "isasync": true, "name": "createBgpPeer", "params": [ - { - "description": "UUID of the zone which the Bgp Peer belongs to.", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "domain ID of the account owning the Bgp Peer", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, { "description": "The password of the Bgp Peer.", "length": 255, @@ -80221,13 +87871,6 @@ "required": false, "type": "string" }, - { - "description": "The AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": true, - "type": "long" - }, { "description": "account who will own the Bgp Peer", "length": 255, @@ -80236,12 +87879,20 @@ "type": "string" }, { - "description": "The IPv6 address of the Bgp Peer.", + "description": "The IPv4 address of the Bgp Peer.", "length": 255, - "name": "ip6address", + "name": "ipaddress", "required": false, "type": "string" }, + { + "description": "domain ID of the account owning the Bgp Peer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, { "description": "project who will own the Bgp Peer", "length": 255, @@ -80251,9 +87902,9 @@ "type": "uuid" }, { - "description": "The IPv4 address of the Bgp Peer.", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "ipaddress", + "name": "ip6address", "required": false, "type": "string" }, @@ -80263,70 +87914,83 @@ "name": "details", "required": false, "type": "map" + }, + { + "description": "UUID of the zone which the Bgp Peer belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "The AS number of the Bgp Peer.", + "length": 255, + "name": "asnumber", + "required": true, + "type": "long" } ], "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ { - "description": "the account of the bgp peer", - "name": "account", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, - {}, - {}, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { @@ -80335,19 +87999,21 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, + {}, { "description": "AS number of bgp peer", "name": "asnumber", "type": "long" + }, + {}, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" } ], "since": "4.20.0" @@ -80393,20 +88059,13 @@ "name": "dedicateBgpPeer", "params": [ { - "description": "domain ID of the account owning the Bgp Peer", + "description": "Id of the Bgp Peer", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, + "name": "id", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "required": true, "type": "uuid" }, - { - "description": "account who will own the Bgp Peer", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "project who will own the Bgp Peer", "length": 255, @@ -80416,49 +88075,67 @@ "type": "uuid" }, { - "description": "Id of the Bgp Peer", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "id", - "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, "type": "uuid" + }, + { + "description": "account who will own the Bgp Peer", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "listBgpPeers,releaseBgpPeer", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" }, { "description": "the project name of the bgp peer", "name": "project", "type": "string" }, + {}, { - "description": "password of bgp peer", - "name": "password", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -80467,46 +88144,35 @@ "type": "string" }, {}, - { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, - {}, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" - }, - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" } ], "since": "4.20.0" @@ -80517,11 +88183,18 @@ "name": "listHostsMetrics", "params": [ { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "", "length": 255, - "name": "details", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" + }, + { + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" }, { "description": "the id of the host", @@ -80532,12 +88205,11 @@ "type": "uuid" }, { - "description": "the Pod ID for the host", + "description": "the state of the host", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the host type", @@ -80547,18 +88219,19 @@ "type": "string" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "the Zone ID for the host", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "hypervisor", + "name": "hahost", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -80575,47 +88248,41 @@ "required": false, "type": "uuid" }, - { - "description": "CPU Arch of the host", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20.1", - "type": "string" - }, { "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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", "required": false, "type": "uuid" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "the name of the storage access group", "length": 255, - "name": "outofbandmanagementenabled", + "name": "storageaccessgroup", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "the state of the host", + "description": "CPU Arch of the host", "length": 255, - "name": "state", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", "length": 255, - "name": "resourcestate", + "name": "outofbandmanagementpowerstate", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", "length": 255, - "name": "keyword", + "name": "resourcestate", "required": false, "type": "string" }, @@ -80627,54 +88294,80 @@ "type": "string" }, { - "description": "the Zone ID for the host", + "description": "the id of the management server", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "managementserverid", + "related": "listManagementServers", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": "", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "pagesize", + "name": "details", "required": false, - "type": "integer" + "type": "list" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "hahost", + "name": "outofbandmanagementenabled", "required": false, "type": "boolean" + }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, - {}, { - "description": "network read in GiB", - "name": "networkread", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -80683,39 +88376,48 @@ "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the name of the host", - "name": "name", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "events available for the host", + "name": "events", "type": "string" }, - {}, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, { "description": "network write in GiB", "name": "networkwrite", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { @@ -80729,68 +88431,78 @@ "type": "integer" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { @@ -80799,161 +88511,226 @@ "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, { "description": "the cpu average load on the host", "name": "cpuloadaverage", "type": "double" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { "description": "the admin that annotated this host", "name": "username", "type": "string" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, { "description": "Maximum X resolution per display", "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -80962,95 +88739,82 @@ "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the host type", - "name": "type", - "type": "type" + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", "name": "memorywithoverprovisioning", "type": "string" }, + {}, { "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", "name": "cpuallocatedwithoverprovisioning", "type": "string" }, + {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "system vm instances on the host", + "name": "systeminstances", + "type": "string" }, { "description": "instances on the host", @@ -81058,89 +88822,54 @@ "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { "description": "the total memory capacity in GiB", "name": "memorytotalgb", "type": "string" }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" } ], "since": "4.9.3" @@ -81160,6 +88889,12 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -81171,16 +88906,10 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -81205,33 +88934,33 @@ "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list the affinity group by the ID provided", + "description": "", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "lists affinity groups by virtual machine ID", "length": 255, - "name": "keyword", + "name": "virtualmachineid", + "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", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -81241,66 +88970,86 @@ "type": "string" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "createProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "lists affinity groups by virtual machine ID", + "description": "lists affinity groups by type", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "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.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "lists affinity groups by type", + "description": "list the affinity group by the ID provided", "length": 255, - "name": "type", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createAffinityGroup", "response": [ + {}, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, { "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -81311,46 +89060,26 @@ "name": "description", "type": "string" }, - {}, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, + {}, { "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" } ] }, @@ -81360,7 +89089,7 @@ "name": "cancelShutdown", "params": [ { - "description": "the uuid of the management server", + "description": "the id of the management server", "length": 255, "name": "managementserverid", "related": "listManagementServers", @@ -81370,33 +89099,53 @@ ], "related": "prepareForShutdown,readyForShutdown", "response": [ + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, { "description": "Indicates whether CloudStack is ready to shutdown", "name": "readyforshutdown", "type": "boolean" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" }, + {}, { "description": "The id of the management server", "name": "managementserverid", @@ -81425,13 +89174,6 @@ "required": false, "type": "uuid" }, - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "an optional project for the ssh key", "length": 255, @@ -81440,6 +89182,13 @@ "required": false, "type": "uuid" }, + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, @@ -81450,10 +89199,15 @@ ], "related": "listSSHKeyPairs", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { - "description": "Name of the keypair", - "name": "name", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { @@ -81461,20 +89215,75 @@ "name": "domain", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" + }, + { + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" + }, + { + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the keypair owner", + "name": "project", + "type": "string" + }, { "description": "ID of the ssh keypair", "name": "id", "type": "string" }, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" + } + ] + }, + { + "description": "Validates if the given activation rule is valid for the informed usage type.", + "isasync": false, + "name": "quotaValidateActivationRule", + "params": [ + { + "description": "Quota tariff's activation rule to validate. The activation rule is valid if it has no syntax errors and all variables are compatible with the given usage type.", + "length": 65535, + "name": "activationrule", + "required": true, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "The Quota usage type used to validate the activation rule.", + "length": 255, + "name": "usagetype", + "required": true, "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "The reason whether the activation rule is valid or not.", + "name": "message", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -81482,32 +89291,29 @@ "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the project id of the keypair owner", - "name": "projectid", - "type": "string" + "description": "Whether the activation rule is valid.", + "name": "isvalid", + "type": "boolean" }, + {}, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "The Quota usage type used to validate the activation rule.", + "name": "quotatype", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "The validated activation rule.", + "name": "activationrule", "type": "string" }, - { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" - } - ] + {} + ], + "since": "4.20.0" }, { "description": "Reserve a public IP to an account.", @@ -81523,18 +89329,12 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" - }, - { - "description": "the account to reserve with this IP address", + "description": "the ID of the public IP address to reserve", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { "description": "the ID of the project to reserve with this IP address", @@ -81545,50 +89345,90 @@ "type": "uuid" }, { - "description": "the ID of the public IP address to reserve", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "id", - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "type": "boolean" + }, + { + "description": "the account to reserve with this IP address", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ - {}, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "public IP address id", "name": "id", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "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", + "name": "purpose", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { @@ -81597,9 +89437,19 @@ "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" }, { "description": "the name of the Network associated with the IP address", @@ -81607,18 +89457,34 @@ "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", "type": "boolean" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + {}, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { @@ -81627,44 +89493,49 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { @@ -81672,13 +89543,18 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -81687,8 +89563,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -81697,18 +89573,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -81722,92 +89593,32 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", "name": "state", "type": "string" - }, - { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "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", - "name": "purpose", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" } ], "since": "4.17" @@ -81817,14 +89628,6 @@ "isasync": false, "name": "deleteEvents", "params": [ - { - "description": "the IDs of the events", - "length": 255, - "name": "ids", - "related": "", - "required": false, - "type": "list" - }, { "description": "delete by event type", "length": 255, @@ -81845,31 +89648,39 @@ "name": "startdate", "required": false, "type": "date" + }, + { + "description": "the IDs of the events", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -81889,18 +89700,13 @@ "description": "the ID of the ISO file", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" } ], "response": [ {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -81911,12 +89717,17 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { @@ -81925,32 +89736,26 @@ "name": "listVPCOfferings", "params": [ { - "description": "list VPC offerings by display text", + "description": "List by keyword", "length": 255, - "name": "displaytext", + "name": "keyword", "required": false, "type": "string" }, { - "description": "true if need to list only default VPC offerings. Default value is false", - "length": 255, - "name": "isdefault", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list VPC offerings by id", + "description": "list VPC offerings available for VPC creation in specific domain", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, + "since": "4.18", "type": "uuid" }, { @@ -81963,12 +89768,19 @@ "type": "uuid" }, { - "description": "list VPC offerings by state", + "description": "list VPC offerings by display text", "length": 255, - "name": "state", + "name": "displaytext", "required": false, "type": "string" }, + { + "description": "true if need to list only default VPC offerings. Default value is false", + "length": 255, + "name": "isdefault", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -81977,20 +89789,18 @@ "type": "integer" }, { - "description": "", + "description": "list VPC offerings by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "list VPC offerings by name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "name", "required": false, - "since": "4.18", - "type": "uuid" + "type": "string" }, { "description": "list VPC offerings supporting certain services", @@ -82000,38 +89810,24 @@ "type": "list" }, { - "description": "list VPC offerings by name", + "description": "list VPC offerings by id", "length": 255, - "name": "name", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updateVPCOffering", "response": [ { - "description": "the id of the vpc offering", - "name": "id", - "type": "string" - }, - { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { @@ -82040,37 +89836,22 @@ "type": "date" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, {}, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, - {}, { "description": "an alternate display text of the vpc offering.", "name": "displaytext", "type": "string" }, - { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" - }, + {}, { "description": "the list of supported services", "name": "service", @@ -82084,29 +89865,24 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, { "description": "state of the network provider", "name": "state", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -82114,6 +89890,11 @@ "name": "servicelist", "type": "list" }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", @@ -82126,6 +89907,11 @@ "description": "the list of capabilities", "name": "capability", "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, { "description": "the capability name", "name": "name", @@ -82135,11 +89921,6 @@ "description": "can this service capability value can be choosable while creatine network offerings", "name": "canchooseservicecapability", "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" } ], "type": "list" @@ -82147,29 +89928,54 @@ ], "type": "list" }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, { "description": "true if vpc offering can be used by NSX networks only", "name": "fornsx", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, { "description": "the name of the vpc offering", "name": "name", "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -82181,6 +89987,11 @@ "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", "type": "string" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" } ] }, @@ -82199,13 +90010,6 @@ ], "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -82215,7 +90019,14 @@ "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", "name": "solidFireVolumeSize", "type": "long" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {} ] }, { @@ -82223,6 +90034,20 @@ "isasync": true, "name": "uploadVolume", "params": [ + { + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, + "type": "string" + }, + { + "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, { "description": "the checksum value of this volume. 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 \"{}\", not including the double quotes. In this 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.", "length": 255, @@ -82231,33 +90056,34 @@ "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", + "description": "Upload volume for the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", "length": 255, - "name": "account", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the volume", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "Upload volume for the project", + "description": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { @@ -82268,177 +90094,136 @@ "type": "string" }, { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "description": "the name of the volume", "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", + "name": "name", "required": true, "type": "string" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" - }, - { - "description": "the ID of the zone the volume is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" } ], "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - {}, { "description": "true if storage snapshot is supported for the volume, false otherwise", "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { @@ -82447,95 +90232,38 @@ "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { @@ -82544,150 +90272,181 @@ "type": "integer" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "ID of the service offering for root disk", @@ -82695,34 +90454,86 @@ "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" } ] }, @@ -82732,19 +90543,18 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the host management interface password", + "description": "the host management interface driver, for example: ipmitool", "length": 255, - "name": "password", + "name": "driver", "required": true, "type": "string" }, { - "description": "the ID of the host", + "description": "the host management interface port", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "port", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the host management interface user", @@ -82761,16 +90571,17 @@ "type": "string" }, { - "description": "the host management interface driver, for example: ipmitool", + "description": "the ID of the host", "length": 255, - "name": "driver", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the host management interface port", + "description": "the host management interface password", "length": 255, - "name": "port", + "name": "password", "required": true, "type": "string" } @@ -82778,57 +90589,51 @@ "related": "enableOutOfBandManagementForHost,changeOutOfBandManagementPassword", "response": [ { - "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, { "description": "the out-of-band management interface username", "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, + {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, - {}, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, - {}, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", @@ -82840,10 +90645,16 @@ "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - } + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.9.0" }, @@ -82852,13 +90663,6 @@ "isasync": false, "name": "listStorageTags", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -82872,100 +90676,58 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the storage tag", - "name": "id", - "type": "string" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the pool ID of the storage tag", - "name": "poolid", - "type": "long" - }, + {}, { "description": "the name of the storage tag", "name": "name", "type": "string" - } - ] - }, - { - "description": "Delete VM Schedule.", - "isasync": false, - "name": "deleteVMSchedule", - "params": [ - { - "description": "IDs of VM schedule", - "length": 255, - "name": "ids", - "related": "", - "required": false, - "type": "list" }, { - "description": "ID of VM", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" + "description": "the pool ID of the storage tag", + "name": "poolid", + "type": "long" }, { - "description": "ID of VM schedule", - "length": 255, + "description": "the ID of the storage tag", "name": "id", - "related": "", - "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } - ], - "since": "4.19.0" + ] }, { "description": "Creates a IPv4 subnet for guest networks.", "isasync": true, "name": "createIpv4SubnetForGuestNetwork", "params": [ + { + "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", + "length": 255, + "name": "cidrsize", + "required": false, + "type": "integer" + }, { "description": "The CIDR of this Ipv4 subnet.", "length": 255, @@ -82980,62 +90742,60 @@ "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "required": true, "type": "uuid" - }, - { - "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", - "length": 255, - "name": "cidrsize", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", - "type": "string" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "type": "string" }, + {}, + { + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "id of network which the IPv4 subnet is associated with.", "name": "networkid", "type": "string" }, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, {}, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, { @@ -83044,70 +90804,106 @@ "type": "string" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "id of the data center IPv4 subnet", - "name": "parentid", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "id of the IPv4 subnet for guest network", + "name": "id", "type": "string" }, { "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "name": "zonename", "type": "string" } ], "since": "4.20.0" }, { - "description": "List template visibility and all accounts that have permissions to view this template.", + "description": "Delete VM Schedule.", "isasync": false, - "name": "listTemplatePermissions", + "name": "deleteVMSchedule", "params": [ { - "description": "the template ID", + "description": "ID of VM schedule", "length": 255, "name": "id", - "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "IDs of VM schedule", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "ID of VM", + "length": 255, + "name": "virtualmachineid", + "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", "required": true, "type": "uuid" } ], - "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "List template visibility and all accounts that have permissions to view this template.", + "isasync": false, + "name": "listTemplatePermissions", + "params": [ { "description": "the template ID", + "length": 255, "name": "id", - "type": "string" - }, + "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", + "required": true, + "type": "uuid" + } + ], + "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", + "response": [ + {}, { "description": "the list of projects the template is available for", "name": "projectids", @@ -83118,16 +90914,31 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, { "description": "true if this template is a public template, false otherwise", "name": "ispublic", "type": "boolean" }, - {}, { "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" } ] }, @@ -83137,11 +90948,11 @@ "name": "listAnnotations", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "the id of the annotation", @@ -83151,24 +90962,18 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "page", + "name": "entityid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the id of the entity for which to show annotations", + "description": "possible values are \"self\" and \"all\". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access", "length": 255, - "name": "entityid", + "name": "annotationfilter", "required": false, + "since": "4.16.0", "type": "string" }, { @@ -83180,11 +90985,10 @@ "type": "string" }, { - "description": "possible values are \"self\" and \"all\". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access", + "description": "List by keyword", "length": 255, - "name": "annotationfilter", + "name": "keyword", "required": false, - "since": "4.16.0", "type": "string" }, { @@ -83193,34 +90997,41 @@ "name": "entitytype", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "addAnnotation", "response": [ { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -83233,16 +91044,7 @@ "type": "date" }, {}, - { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the contents of the annotation", "name": "annotation", @@ -83253,12 +91055,21 @@ "name": "username", "type": "string" }, + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, { "description": "the (uu)id of the annotation", "name": "id", "type": "string" }, - {} + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" + } ], "since": "4.11" }, @@ -83268,30 +91079,30 @@ "name": "addSwift", "params": [ { - "description": "the URL for swift", + "description": "the username for swift", "length": 255, - "name": "url", - "required": true, + "name": "username", + "required": false, "type": "string" }, { - "description": "the username for swift", + "description": "the account for swift", "length": 255, - "name": "username", + "name": "account", "required": false, "type": "string" }, { - "description": " key for the user for swift", + "description": "the URL for swift", "length": 255, - "name": "key", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "the account for swift", + "description": " key for the user for swift", "length": 255, - "name": "account", + "name": "key", "required": false, "type": "string" } @@ -83299,23 +91110,39 @@ "related": "addSecondaryStorage,listSwifts,addImageStore", "response": [ { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the name of the image store", + "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the url of the image store", "name": "url", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { @@ -83324,10 +91151,26 @@ "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + {}, { "description": "the ID of the image store", "name": "id", @@ -83337,41 +91180,159 @@ "description": "the protocol of the image store", "name": "protocol", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Updates a vGPU profile in the system", + "isasync": false, + "name": "updateVgpuProfile", + "params": [ + { + "description": "the maximum Y resolution", + "length": 255, + "name": "maxresolutiony", + "required": false, + "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the name of the vGPU profile", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the vGPU profile", + "length": 255, + "name": "id", + "related": "createVgpuProfile,updateVgpuProfile", + "required": true, + "type": "uuid" + }, + { + "description": "the maximum number of vGPUs per physical GPU", + "length": 255, + "name": "maxvgpuperphysicalgpu", + "required": false, + "type": "long" + }, + { + "description": "the description of the vGPU profile", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the maximum number of display heads", + "length": 255, + "name": "maxheads", + "required": false, + "type": "long" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the video RAM size in MB", + "length": 255, + "name": "videoram", + "required": false, "type": "long" }, - {}, + { + "description": "the maximum X resolution", + "length": 255, + "name": "maxresolutionx", + "required": false, + "type": "long" + } + ], + "related": "createVgpuProfile", + "response": [ + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the vGPU profile", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" + }, + { + "description": "the description of the vGPU profile", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", + "type": "long" + }, + { + "description": "the ID of the GPU card", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the vendor name of the GPU card", + "name": "vendorname", + "type": "string" + }, + {}, + { + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, + { + "description": "the device name of the GPU card", + "name": "devicename", + "type": "string" + }, + { + "description": "the display name of the GPU card", + "name": "name", "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" } ], - "since": "3.0.0" + "since": "4.21.0" }, { "description": "Lists snapshot policies.", @@ -83379,35 +91340,26 @@ "name": "listSnapshotPolicies", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the disk volume", + "description": "the ID of the snapshot policy", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "id", + "related": "updateSnapshotPolicy,listSnapshotPolicies", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the snapshot policy", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy,listSnapshotPolicies", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -83417,54 +91369,64 @@ "type": "integer" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" } ], "related": "updateSnapshotPolicy", "response": [ { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", "type": "set" }, - {}, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + {}, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { @@ -83476,11 +91438,6 @@ "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "tag key name", "name": "key", @@ -83492,33 +91449,33 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -83527,8 +91484,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], @@ -83539,7 +91501,11 @@ "name": "fordisplay", "type": "boolean" }, - {}, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", @@ -83553,39 +91519,19 @@ "name": "updateVpnCustomerGateway", "params": [ { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", - "length": 255, - "name": "ipsecpsk", - "required": true, - "type": "string" - }, - { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "name of this customer gateway", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "name", + "name": "splitconnections", "required": false, - "type": "string" - }, - { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" + "since": "4.15.1", + "type": "boolean" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", "length": 255, - "name": "account", + "name": "ikeversion", "required": false, + "since": "4.15.1", "type": "string" }, { @@ -83596,27 +91542,25 @@ "type": "string" }, { - "description": "id of customer gateway", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "id", - "related": "updateVpnCustomerGateway", + "name": "ikepolicy", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "splitconnections", + "name": "dpd", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "Force encapsulation for Nat Traversal", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "forceencap", + "name": "ikelifetime", "required": false, - "type": "boolean" + "type": "long" }, { "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", @@ -83626,33 +91570,40 @@ "type": "long" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "description": "Force encapsulation for Nat Traversal", "length": 255, - "name": "ikeversion", + "name": "forceencap", + "required": false, + "type": "boolean" + }, + { + "description": "name of this customer gateway", + "length": 255, + "name": "name", "required": false, - "since": "4.15.1", "type": "string" }, { - "description": "IKE policy of the customer gateway", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "ikepolicy", + "name": "ipsecpsk", "required": true, "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", "length": 255, - "name": "dpd", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "ikelifetime", + "name": "account", "required": false, - "type": "long" + "type": "string" }, { "description": "ESP policy of the customer gateway", @@ -83660,38 +91611,48 @@ "name": "esppolicy", "required": true, "type": "string" + }, + { + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnCustomerGateway", + "required": true, + "type": "uuid" + }, + { + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { @@ -83700,18 +91661,13 @@ "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "the owner", - "name": "account", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { @@ -83719,10 +91675,9 @@ "name": "name", "type": "string" }, - {}, { - "description": "the vpn gateway ID", - "name": "id", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { @@ -83731,20 +91686,20 @@ "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "IPsec policy of customer gateway", @@ -83752,29 +91707,35 @@ "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the owner", + "name": "account", + "type": "string" }, { "description": "the project name", "name": "project", "type": "string" }, + {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Lifetime of IKE SA of customer gateway", @@ -83782,8 +91743,13 @@ "type": "long" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" } ] @@ -83794,18 +91760,11 @@ "name": "applyTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": true, - "type": "string" - }, - { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of networks", "length": 255, - "name": "applicationpolicysetuuid", + "name": "networkuuid", "required": false, - "type": "string" + "type": "list" }, { "description": "the uuid of Tungsten-Fabric policy", @@ -83815,18 +91774,25 @@ "type": "string" }, { - "description": "the uuid of nics", + "description": "the uuid of vms", "length": 255, - "name": "nicuuid", + "name": "vmuuid", "required": false, "type": "list" }, { - "description": "the uuid of networks", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "networkuuid", + "name": "applicationpolicysetuuid", "required": false, - "type": "list" + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, + "type": "string" }, { "description": "the ID of zone", @@ -83837,29 +91803,30 @@ "type": "uuid" }, { - "description": "the uuid of vms", + "description": "the uuid of nics", "length": 255, - "name": "vmuuid", + "name": "nicuuid", "required": false, "type": "list" } ], "related": "", "response": [ + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list Tungsten-Fabric network", - "name": "network", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" }, { "description": "Tungsten-Fabric tag name", @@ -83868,9 +91835,9 @@ }, {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { "description": "list Tungsten-Fabric vm", @@ -83878,9 +91845,9 @@ "type": "list" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "list Tungsten-Fabric nic", @@ -83888,14 +91855,13 @@ "type": "list" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" } ] @@ -83905,13 +91871,6 @@ "isasync": false, "name": "updateObjectStoragePool", "params": [ - { - "description": "the name for the object store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "Object Store ID", "length": 255, @@ -83926,25 +91885,34 @@ "name": "url", "required": false, "type": "string" + }, + { + "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts. Set to 0 to stop tracking.", + "length": 255, + "name": "size", + "required": false, + "since": "4.21", + "type": "long" + }, + { + "description": "the name for the object store", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "addObjectStoragePool", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the object store", + "name": "id", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the provider name of the object store", + "name": "providername", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -83952,132 +91920,227 @@ "type": "boolean" }, { - "description": "the url of the object store", - "name": "url", + "description": "the name of the object store", + "name": "name", "type": "string" }, - {}, { - "description": "the ID of the object store", - "name": "id", + "description": "the object store currently used size", + "name": "storageused", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the total size of the object store", "name": "storagetotal", "type": "long" }, + {}, { - "description": "the name of the object store", - "name": "name", - "type": "string" + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the url of the object store", + "name": "url", "type": "string" } ], "since": "4.19.0" }, { - "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", + "description": "Register an extension with a resource", "isasync": false, - "name": "lockAccount", + "name": "registerExtension", "params": [ { - "description": "Locks the specified account on this domain.", + "description": "ID of the extension", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": true, "type": "uuid" }, { - "description": "Locks the specified account.", + "description": "ID of the resource to register the extension with", "length": 255, - "name": "account", + "name": "resourceid", + "required": true, + "type": "string" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "Type of the resource", + "length": 255, + "name": "resourcetype", "required": true, "type": "string" } ], - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "response": [ - {}, { - "description": "details for the account", - "name": "accountdetails", + "description": "The details of the extension", + "name": "details", "type": "map" }, + {}, + {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "Type of the extension", + "name": "type", + "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "ID of the extension", + "name": "id", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "The state of the extension", + "name": "state", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", + "description": "Description of the extension", + "name": "description", + "type": "string" + }, + { + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + } + ], "type": "list" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "Name of the extension", + "name": "name", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" }, + {}, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + } + ], + "since": "4.21.0" + }, + { + "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", + "isasync": false, + "name": "lockAccount", + "params": [ + { + "description": "Locks the specified account.", + "length": 255, + "name": "account", + "required": true, "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "Locks the specified account on this domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + } + ], + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "response": [ + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { "description": "the total number of virtual machines available for this account to acquire", @@ -84085,84 +92148,89 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, {}, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { @@ -84170,8 +92238,8 @@ "name": "user", "response": [ { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { @@ -84180,28 +92248,28 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user state", + "name": "state", "type": "string" }, { @@ -84210,59 +92278,44 @@ "type": "boolean" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the account name of the user", - "name": "account", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { "description": "true if user is default, false otherwise", @@ -84270,13 +92323,13 @@ "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -84285,31 +92338,112 @@ "type": "apikeyaccess" }, { - "description": "the user email address", - "name": "email", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" } ], "type": "list" }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + {}, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" + }, { "description": "true if account is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { @@ -84318,53 +92452,68 @@ "type": "integer" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the id of the account", + "name": "id", "type": "string" }, { @@ -84373,34 +92522,59 @@ "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, { "description": "the total number of virtual machines stopped for this account", "name": "vmstopped", "type": "integer" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { "description": "true if the account requires cleanup", @@ -84408,43 +92582,63 @@ "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the state of the account", - "name": "state", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" } ] @@ -84454,13 +92648,6 @@ "isasync": true, "name": "stopRouter", "params": [ - { - "description": "Force stop the VM (vm 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 VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "the ID of the router", "length": 255, @@ -84468,72 +92655,95 @@ "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" + }, + { + "description": "Force stop the VM (vm 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 VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, + {}, { "description": "the list of nics associated with the router", "name": "nic", "response": [ + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, { "description": "IP addresses associated with NIC found for unmanaged VM", "name": "ipaddresses", "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, { "description": "the cidr of IPv6 network", "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -84547,34 +92757,34 @@ "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "the netmask of the nic", @@ -84582,18 +92792,18 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -84602,28 +92812,23 @@ "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -84632,97 +92837,97 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" } ], "type": "set" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { "description": "true if the router template requires upgrader", @@ -84730,51 +92935,51 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the name of the router", + "name": "name", "type": "string" }, - {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, + {}, { "description": "Last executed health check result for the router", "name": "healthcheckresults", @@ -84784,16 +92989,6 @@ "name": "checktype", "type": "string" }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, { "description": "the name of the health check on the router", "name": "checkname", @@ -84803,53 +92998,53 @@ "description": "detailed response generated on running health check", "name": "details", "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" } ], "type": "list" }, { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { @@ -84858,90 +93053,89 @@ "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, - {}, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -84960,9 +93154,10 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -84971,16 +93166,15 @@ "type": "boolean" }, {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "3.0.0" @@ -85022,42 +93216,42 @@ ], "related": "", "response": [ - { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" - }, + {}, { "description": "Tungsten-Fabric firewall policy uuid", "name": "uuid", "type": "string" }, - {}, + { + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - {}, { "description": "Tungsten-Fabric firewall policy name", "name": "name", "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -85090,28 +93284,12 @@ ], "related": "", "response": [ - { - "description": "the ID of the region", - "name": "id", - "type": "integer" - }, - { - "description": "the name of the region", - "name": "name", - "type": "string" - }, - {}, - {}, { "description": "true if GSLB service is enabled in the region, false otherwise", "name": "gslbserviceenabled", "type": "boolean" }, - { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" - }, + {}, { "description": "true if security groups support is enabled, false otherwise", "name": "portableipserviceenabled", @@ -85126,7 +93304,23 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the ID of the region", + "name": "id", + "type": "integer" + }, + { + "description": "the end point of the region", + "name": "endpoint", + "type": "string" + }, + { + "description": "the name of the region", + "name": "name", + "type": "string" + }, + {} ] }, { @@ -85144,17 +93338,12 @@ } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -85165,7 +93354,12 @@ "name": "jobstatus", "type": "integer" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "3.0.0" }, @@ -85175,9 +93369,9 @@ "name": "destroySharedFileSystem", "params": [ { - "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", + "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", "length": 255, - "name": "expunge", + "name": "forced", "required": false, "type": "boolean" }, @@ -85190,20 +93384,14 @@ "type": "uuid" }, { - "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", + "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", "length": 255, - "name": "forced", + "name": "expunge", "required": false, "type": "boolean" } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -85214,12 +93402,18 @@ "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.20.0" }, @@ -85248,50 +93442,50 @@ "related": "", "response": [ { - "description": "the ID of the project", - "name": "projectid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, + {}, + {}, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the project role permission", - "name": "id", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, - {}, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", + "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" } ], @@ -85309,6 +93503,13 @@ "required": false, "type": "integer" }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -85324,11 +93525,12 @@ "type": "integer" }, { - "description": "Hostname", + "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", "length": 255, - "name": "hostname", + "name": "listall", "required": false, - "type": "string" + "since": "4.13.2", + "type": "boolean" }, { "description": "linked domain", @@ -85344,45 +93546,37 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", - "length": 255, - "name": "listall", - "required": false, - "since": "4.13.2", - "type": "boolean" } ], "related": "addLdapConfiguration", "response": [ { - "description": "linked domain", - "name": "domainid", - "type": "string" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "linked domain", + "name": "domainid", + "type": "string" + }, { "description": "name of the host running the ldap server", "name": "hostname", "type": "string" }, - {}, - { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" - } + {} ], "since": "4.2.0" }, @@ -85392,11 +93586,11 @@ "name": "createRemoteAccessVpn", "params": [ { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", "length": 255, - "name": "openfirewall", + "name": "iprange", "required": false, - "type": "boolean" + "type": "string" }, { "description": "public ip address id of the vpn server", @@ -85406,13 +93600,6 @@ "required": true, "type": "uuid" }, - { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", - "length": 255, - "name": "iprange", - "required": false, - "type": "string" - }, { "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, @@ -85422,11 +93609,10 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", "length": 255, - "name": "fordisplay", + "name": "openfirewall", "required": false, - "since": "4.4", "type": "boolean" }, { @@ -85435,43 +93621,47 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "listRemoteAccessVpns", "response": [ { - "description": "the state of the rule", - "name": "state", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" }, { "description": "the public ip address of the vpn server", "name": "publicipid", "type": "string" }, + {}, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { @@ -85480,8 +93670,8 @@ "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -85489,31 +93679,35 @@ "name": "presharedkey", "type": "string" }, - {}, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the domain id of the account of the remote access vpn", "name": "domainid", "type": "string" }, - {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, + {}, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" } ] @@ -85523,14 +93717,6 @@ "isasync": false, "name": "changeServiceForVirtualMachine", "params": [ - { - "description": "the service offering ID to apply to the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, { "description": "New maximum number of IOPS for the custom disk offering", "length": 255, @@ -85547,6 +93733,14 @@ "since": "4.17", "type": "boolean" }, + { + "description": "the service offering ID to apply to the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, { "description": "New minimum number of IOPS for the custom disk offering", "length": 255, @@ -85556,12 +93750,12 @@ "type": "long" }, { - "description": "The ID of the virtual machine", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" }, { "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", @@ -85571,185 +93765,98 @@ "type": "map" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "The ID of the virtual machine", "length": 255, - "name": "automigrate", - "required": false, - "since": "4.17", - "type": "boolean" + "name": "id", + "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", + "required": true, + "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,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": [ { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -85758,8 +93865,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -85768,23 +93875,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -85796,59 +93903,68 @@ "description": "the project id the tag belongs to", "name": "projectid", "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], "type": "set" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { @@ -85857,111 +93973,84 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - {}, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {}, { "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { "description": "the ID of the domain in which the virtual machine exists", @@ -85969,130 +94058,115 @@ "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -86101,88 +94175,73 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -86191,23 +94250,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -86216,104 +94275,84 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "name": "account", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -86322,37 +94361,153 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], "type": "set" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "security group name", "name": "securitygroupname", "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + {}, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -86360,55 +94515,131 @@ "name": "vnfnics", "type": "list" }, + {}, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { "description": "device id for the network when plugged into the virtual machine", "name": "deviceid", @@ -86420,33 +94651,33 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -86455,172 +94686,143 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" } ], "type": "set" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": "path of the domain in which the virtual machine exists", @@ -86628,19 +94830,9 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { "description": "the VM's disk write in KiB", @@ -86648,33 +94840,95 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" } ] @@ -86685,11 +94939,12 @@ "name": "listGuestOsMapping", "params": [ { - "description": "list Guest OS mapping by OS mapping name with hypervisor", + "description": "list mapping by Guest OS Type UUID", "length": 255, - "name": "osnameforhypervisor", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", @@ -86699,33 +94954,32 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list Guest OS mapping by hypervisor", "length": 255, - "name": "keyword", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", + "description": "list Guest OS mapping by OS display name", "length": 255, - "name": "hypervisor", + "name": "osdisplayname", "required": false, "type": "string" }, { - "description": "list mapping by Guest OS Type UUID", + "description": "list Guest OS mapping by OS mapping name with hypervisor", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "osnameforhypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list Guest OS mapping by OS display name", + "description": "", "length": 255, - "name": "osdisplayname", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list mapping by its UUID", @@ -86736,24 +94990,27 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ - {}, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the ID of the Guest OS mapping", "name": "id", @@ -86764,24 +95021,25 @@ "name": "osnameforhypervisor", "type": "string" }, + {}, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { @@ -86789,15 +95047,11 @@ "name": "hypervisor", "type": "string" }, + {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.4.0" @@ -86808,34 +95062,27 @@ "name": "listTemplates", "params": [ { - "description": "If set to true, list only unique templates across zones", + "description": "list templates by zoneId", "length": 255, - "name": "showunique", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "isrecursive", + "name": "isvnf", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "ID of the image or image cache store", @@ -86847,89 +95094,86 @@ "type": "uuid" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "List by keyword", "length": 255, - "name": "arch", + "name": "keyword", "required": false, - "since": "4.20", "type": "string" }, { - "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 VM. * 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 a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the template ID", "length": 255, - "name": "account", + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the type of the template", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "templatetype", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.19.0", - "type": "string" + "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "hypervisor", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "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.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "ID of the storage pool", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "hypervisor", "required": false, - "since": "4.19", - "type": "uuid" + "type": "string" }, { - "description": "list datadisk templates by parent template id", + "description": "the template name", "length": 255, - "name": "parenttemplateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "name", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "list templates by zoneId", + "description": "list templates that can be used to deploy CKS clusters", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "forcks", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { "description": "show removed templates as well", @@ -86939,26 +95183,27 @@ "type": "boolean" }, { - "description": "the template name", + "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.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "pagesize", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the type of the template", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "templatetype", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { "description": "flag to display the resource image for the templates", @@ -86968,74 +95213,87 @@ "type": "boolean" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "ID of the storage pool", "length": 255, - "name": "ids", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.9", - "type": "list" + "since": "4.19", + "type": "uuid" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "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 VM. * 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 a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", "length": 255, - "name": "isvnf", + "name": "templatefilter", + "required": true, + "type": "string" + }, + { + "description": "list templates that are ready to be deployed", + "length": 255, + "name": "isready", "required": false, - "since": "4.19.0", + "since": "4.21.0", "type": "boolean" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "details", + "name": "ids", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.15", + "since": "4.9", "type": "list" - } - ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "the ID of the OS category for the template", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "length": 255, + "name": "details", + "required": false, + "since": "4.15", + "type": "list" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "list datadisk templates by parent template id", + "length": 255, + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "since": "4.4", + "type": "uuid" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, + "description": "ID of the extension for the template", + "length": 255, + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "required": false, + "since": "4.21.0", + "type": "uuid" + } + ], + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { "description": "the current status of the latest async job acting on this object", @@ -87043,70 +95301,59 @@ "type": "integer" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, - {}, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { "description": "true if the template is extractable, false otherwise", @@ -87114,72 +95361,22 @@ "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "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", - "name": "userdataparams", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -87188,8 +95385,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -87198,8 +95395,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -87208,37 +95410,97 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "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", + "name": "userdataparams", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", @@ -87246,13 +95508,8 @@ "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "additional key/value details tied with template", - "name": "details", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", "type": "map" }, { @@ -87261,54 +95518,81 @@ "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, - {}, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, { "description": "the name of userdata linked to this template", "name": "userdataname", "type": "string" }, + {}, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, + {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + {}, { "description": "the size of the template", "name": "size", "type": "long" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { @@ -87317,29 +95601,49 @@ "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" } ] }, @@ -87367,33 +95671,18 @@ "related": "listTungstenFabricPolicy", "response": [ {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, {}, + {}, { "description": "Tungsten-Fabric policy name", "name": "name", @@ -87403,6 +95692,21 @@ "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" } ] }, @@ -87422,9 +95726,9 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if operation is executed successfully", @@ -87437,12 +95741,12 @@ "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.20.0" }, @@ -87452,18 +95756,25 @@ "name": "createBucket", "params": [ { - "description": "the name of the bucket", + "description": "Enable object locking in bucket", "length": 255, - "name": "name", + "name": "objectlocking", + "required": false, + "type": "boolean" + }, + { + "description": "Bucket Quota in GiB", + "length": 255, + "name": "quota", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "description": "Enable bucket encryption", "length": 255, - "name": "account", + "name": "encryption", "required": false, - "type": "string" + "type": "boolean" }, { "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.", @@ -87482,25 +95793,11 @@ "type": "uuid" }, { - "description": "Enable object locking in bucket", - "length": 255, - "name": "objectlocking", - "required": false, - "type": "boolean" - }, - { - "description": "Bucket Quota in GB", - "length": 255, - "name": "quota", - "required": false, - "type": "integer" - }, - { - "description": "Enable bucket encryption", + "description": "the name of the bucket", "length": 255, - "name": "encryption", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { "description": "Id of the Object Storage Pool where bucket is created", @@ -87517,6 +95814,13 @@ "required": false, "type": "string" }, + { + "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Enable bucket versioning", "length": 255, @@ -87528,10 +95832,15 @@ "related": "listBuckets", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the Bucket", + "name": "name", "type": "string" }, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, { "description": "the project id of the bucket", "name": "projectid", @@ -87547,73 +95856,23 @@ "name": "created", "type": "date" }, - { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Object storage provider", - "name": "provider", - "type": "string" - }, - { - "description": "name of the Bucket", - "name": "name", - "type": "string" - }, - { - "description": "the account associated with the Bucket", - "name": "account", - "type": "string" - }, - { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" - }, - { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", - "type": "string" - }, - { - "description": "Bucket URL", - "name": "url", - "type": "string" - }, - { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -87622,13 +95881,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -87637,53 +95896,88 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "State of the Bucket", - "name": "state", + "description": "Object storage provider", + "name": "provider", "type": "string" }, - {}, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, + { + "description": "the project name of the bucket", + "name": "project", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "Bucket Encryption", "name": "encryption", "type": "boolean" }, + { + "description": "Bucket URL", + "name": "url", + "type": "string" + }, + { + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, + {}, { "description": "Bucket Access Key", "name": "accesskey", "type": "string" }, - {}, { - "description": "ID of the Bucket", - "name": "id", + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" }, { @@ -87692,29 +95986,39 @@ "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "ID of the Bucket", + "name": "id", "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, { - "description": "Bucket Access Policy", - "name": "policy", + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", "type": "string" }, { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Bucket Secret Key", "name": "usersecretkey", "type": "string" + }, + { + "description": "State of the Bucket", + "name": "state", + "type": "string" } ], "since": "4.19.0" @@ -87725,55 +96029,56 @@ "name": "listPhysicalNetworks", "params": [ { - "description": "", + "description": "the Zone ID for the physical network", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list physical network by id", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "list physical network by id", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "search by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the Zone ID for the physical network", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "search by name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "updatePhysicalNetwork", "response": [ + {}, { - "description": "state of the physical network", - "name": "state", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { @@ -87781,30 +96086,29 @@ "name": "domainid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { @@ -87813,26 +96117,26 @@ "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "name of the physical network", + "name": "name", "type": "string" }, + {}, { - "description": "the uuid of the physical network", - "name": "id", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the physical network", + "name": "state", "type": "string" }, - {}, { "description": "the vlan of the physical network", "name": "vlan", @@ -87847,11 +96151,12 @@ "name": "listFirewallRules", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "isrecursive", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -87861,6 +96166,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -87869,45 +96181,47 @@ "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "list firewall rules for certain network", "length": 255, - "name": "pagesize", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "integer" + "since": "4.3", + "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of IP address of the firewall services", + "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.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, @@ -87920,72 +96234,48 @@ "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list firewall rules for certain network", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, - "since": "4.3", "type": "uuid" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, {}, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -87998,13 +96288,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -88013,8 +96298,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -88022,38 +96307,57 @@ "name": "customer", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { @@ -88062,14 +96366,14 @@ "type": "integer" }, { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", @@ -88077,19 +96381,19 @@ "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -88108,6 +96412,16 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, {}, { @@ -88119,400 +96433,390 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Extracts an ISO", - "isasync": true, - "name": "extractIso", + "description": "Lists all Routing firewall rules", + "isasync": false, + "name": "listRoutingFirewallRules", "params": [ { - "description": "the ID of the zone where the ISO is originally located", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list Routing firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", "required": false, "type": "string" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "List by keyword", "length": 255, - "name": "mode", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the ISO file", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "Lists Routing firewall rule with the specified ID", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": false, "type": "uuid" - } - ], - "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", - "response": [ + }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", + "description": "list Routing firewall rules by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "response": [ { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, + {}, { - "description": "the name of the extracted object", - "name": "name", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "", - "name": "resultstring", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Lists all Routing firewall rules", - "isasync": false, - "name": "listRoutingFirewallRules", - "params": [ - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "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.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, + {}, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, { - "description": "list Routing firewall rules by network ID", - "length": 255, + "description": "the id of the guest network the port forwarding rule belongs to", "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Extracts an ISO", + "isasync": true, + "name": "extractIso", + "params": [ { - "description": "list Routing firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of the ISO file", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "Lists Routing firewall rule with the specified ID", + "description": "the ID of the zone where the ISO is originally located", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "keyword", - "required": false, + "name": "mode", + "required": true, "type": "string" } ], - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", "response": [ { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the ID of the port forwarding rule", + "description": "the id of extracted object", "name": "id", "type": "string" }, + {}, + {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", "type": "integer" }, - {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" } - ], - "since": "4.20.0" + ] }, { "description": "Creates an affinity/anti-affinity group", @@ -88520,17 +96824,17 @@ "name": "createAffinityGroup", "params": [ { - "description": "Type of the affinity group from the available affinity/anti-affinity group types", + "description": "optional description of the affinity group", "length": 255, - "name": "type", - "required": true, + "name": "description", + "required": false, "type": "string" }, { - "description": "optional description of the affinity group", + "description": "name of the affinity group", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -88542,16 +96846,9 @@ "type": "uuid" }, { - "description": "an account for the affinity group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "name of the affinity group", + "description": "Type of the affinity group from the available affinity/anti-affinity group types", "length": 255, - "name": "name", + "name": "type", "required": true, "type": "string" }, @@ -88562,13 +96859,20 @@ "related": "createProject", "required": false, "type": "uuid" + }, + { + "description": "an account for the affinity group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -88576,36 +96880,27 @@ "name": "id", "type": "string" }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, + {}, {}, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the affinity group", + "name": "name", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { "description": "the account owning the affinity group", @@ -88613,29 +96908,38 @@ "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, - {}, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, { "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ] @@ -88646,10 +96950,17 @@ "name": "oauthlogin", "params": [ { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", "length": 255, - "name": "secretcode", + "name": "domainId", "required": false, + "type": "long" + }, + { + "description": "Email id with which user tried to login using OAuth provider", + "length": 255, + "name": "email", + "required": true, "type": "string" }, { @@ -88660,38 +96971,40 @@ "type": "string" }, { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", "length": 255, - "name": "domainId", + "name": "domain", "required": false, - "type": "long" - }, - { - "description": "Email id with which user tried to login using OAuth provider", - "length": 255, - "name": "email", - "required": true, "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, - "name": "domain", + "name": "secretcode", "required": false, "type": "string" } ], - "related": "samlSso", + "related": "", "response": [ - {}, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "User ID", - "name": "userid", + "description": "Username", + "name": "username", + "type": "string" + }, + { + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { @@ -88700,49 +97013,50 @@ "type": "integer" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, + {}, { - "description": "Username", - "name": "username", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, + {}, { - "description": "user time zone", - "name": "timezone", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "Domain ID that the user belongs to", + "name": "domainid", + "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "Management Server ID that the user logged to", + "name": "managementserverid", "type": "string" }, - {}, { - "description": "Is user registered", - "name": "registered", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { @@ -88751,28 +97065,23 @@ "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", - "type": "string" - }, - { - "description": "last name of the user", - "name": "lastname", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "last name of the user", + "name": "lastname", "type": "string" } ], @@ -88783,6 +97092,13 @@ "isasync": false, "name": "listInternalLoadBalancerElements", "params": [ + { + "description": "list internal load balancer elements by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" + }, { "description": "List by keyword", "length": 255, @@ -88791,26 +97107,26 @@ "type": "string" }, { - "description": "", + "description": "list internal load balancer elements by id", "length": 255, - "name": "page", + "name": "id", + "related": "listInternalLoadBalancerElements", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list internal load balancer elements by enabled state", + "description": "", "length": 255, - "name": "enabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list internal load balancer elements by id", + "description": "", "length": 255, - "name": "id", - "related": "listInternalLoadBalancerElements", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list internal load balancer elements by network service provider id", @@ -88819,17 +97135,21 @@ "related": "addNetworkServiceProvider,listTrafficTypes", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" + }, + {}, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -88841,22 +97161,11 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" - }, - { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" - }, { "description": "the id of the internal load balancer element", "name": "id", "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -88865,6 +97174,13 @@ "isasync": true, "name": "getHypervisorGuestOsNames", "params": [ + { + "description": "Hypervisor type. One of : VMware, XenServer", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, { "description": "Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available)", "length": 255, @@ -88878,21 +97194,19 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "Hypervisor type. One of : VMware, XenServer", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "version of the hypervisor for guest os names", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the guest OS list of the hypervisor", @@ -88912,27 +97226,22 @@ "type": "list" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the guest OS count of the hypervisor", "name": "guestoscount", "type": "integer" }, { - "description": "version of the hypervisor for guest os names", - "name": "hypervisorversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the hypervisor", "name": "hypervisor", "type": "string" - } + }, + {} ], "since": "4.19.0" }, @@ -88942,16 +97251,9 @@ "name": "createTungstenFabricProvider", "params": [ { - "description": "Tungsten-Fabric provider introspect port", - "length": 255, - "name": "tungstenproviderintrospectport", - "required": false, - "type": "string" - }, - { - "description": "Tungsten-Fabric provider hostname", + "description": "Tungsten-Fabric provider gateway", "length": 255, - "name": "tungstenproviderhostname", + "name": "tungstengateway", "required": true, "type": "string" }, @@ -88970,19 +97272,12 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", + "description": "Tungsten-Fabric provider hostname", "length": 255, - "name": "tungstengateway", + "name": "tungstenproviderhostname", "required": true, "type": "string" }, - { - "description": "Tungsten-Fabric provider vrouter port", - "length": 255, - "name": "tungstenprovidervrouterport", - "required": false, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -88990,39 +97285,52 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric provider introspect port", + "length": 255, + "name": "tungstenproviderintrospectport", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider vrouter port", + "length": 255, + "name": "tungstenprovidervrouterport", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { @@ -89031,29 +97339,30 @@ "type": "string" }, {}, + {}, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider name", + "name": "name", + "type": "string" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric provider name", - "name": "name", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" } ] @@ -89083,17 +97392,22 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,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", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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": [ { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { "description": "the name of the host for the virtual machine", @@ -89101,211 +97415,408 @@ "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" } ], "type": "set" }, - {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, + {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -89314,93 +97825,113 @@ "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, { "description": "the pool type of the virtual machine", "name": "pooltype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -89411,53 +97942,38 @@ "name": "startport", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -89471,18 +97987,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], @@ -89492,23 +98008,11 @@ "description": "security group name", "name": "securitygroupname", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "account owning the security group rule", @@ -89516,14 +98020,36 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the protocol of the security group rule", @@ -89531,13 +98057,18 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -89545,88 +98076,123 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -89635,8 +98201,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -89645,8 +98211,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -89655,536 +98221,339 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name of the group", + "name": "project", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the account owning the security group", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, - {}, - {}, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, { "description": "the id of userdata used for the VM", "name": "userdataid", "type": "string" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, { "description": "the ID of the backup offering of the virtual machine", "name": "backupofferingid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - } - ], - "type": "set" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" } ] }, @@ -90203,7 +98572,6 @@ } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -90220,6 +98588,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -90233,14 +98602,6 @@ "isasync": false, "name": "addVirtualMachinesToKubernetesCluster", "params": [ - { - "description": "the IDs of the VMs to add to the cluster", - "length": 255, - "name": "virtualmachineids", - "related": "deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "list" - }, { "description": "Is control node or not? Defaults to false.", "length": 255, @@ -90255,15 +98616,19 @@ "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "required": true, "type": "uuid" + }, + { + "description": "the IDs of the VMs to add to the cluster", + "length": 255, + "name": "virtualmachineids", + "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", + "required": true, + "type": "list" } ], "response": [ {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -90274,7 +98639,11 @@ "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -90289,23 +98658,24 @@ "name": "listTungstenFabricLogicalRouter", "params": [ { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric logical router", "length": 255, - "name": "keyword", + "name": "logicalrouteruuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "the ID of zone", "length": 255, - "name": "networkuuid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric logical router", + "description": "List by keyword", "length": 255, - "name": "logicalrouteruuid", + "name": "keyword", "required": false, "type": "string" }, @@ -90317,12 +98687,11 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -90339,6 +98708,13 @@ "name": "name", "type": "string" }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + {}, { "description": "list Tungsten-Fabric policy network name", "name": "network", @@ -90349,16 +98725,6 @@ "name": "zoneid", "type": "long" }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -90369,8 +98735,11 @@ "name": "jobstatus", "type": "integer" }, - {}, - {} + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + } ] }, { @@ -90379,12 +98748,11 @@ "name": "listBackupOfferings", "params": [ { - "description": "The zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -90394,34 +98762,40 @@ "type": "integer" }, { - "description": "", + "description": "The backup offering ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listBackupOfferings,updateBackupOffering", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "The zone ID", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The backup offering ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listBackupOfferings,updateBackupOffering", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "updateBackupOffering", "response": [ + { + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" + }, {}, { - "description": "name for the backup offering", - "name": "name", + "description": "zone name", + "name": "zonename", "type": "string" }, { @@ -90429,49 +98803,166 @@ "name": "created", "type": "date" }, + { + "description": "provider name", + "name": "provider", + "type": "string" + }, {}, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "external ID on the provider side", + "name": "externalid", + "type": "string" }, { "description": "description for the backup offering", "name": "description", "type": "string" }, + { + "description": "name for the backup offering", + "name": "name", + "type": "string" + }, + { + "description": "ID of the backup offering", + "name": "id", + "type": "string" + }, + { + "description": "zone ID", + "name": "zoneid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ID of the backup offering", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Lists all available GPU cards", + "isasync": false, + "name": "listGpuCards", + "params": [ + { + "description": "device ID of the GPU card", + "length": 255, + "name": "deviceid", + "required": false, + "type": "string" + }, + { + "description": "device name of the GPU card", + "length": 255, + "name": "devicename", + "required": false, + "type": "string" + }, + { + "description": "vendor ID of the GPU card", + "length": 255, + "name": "vendorid", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "ID of the GPU card", + "length": 255, "name": "id", + "related": "listGpuCards", + "required": false, + "type": "uuid" + }, + { + "description": "vendor name of the GPU card", + "length": 255, + "name": "vendorname", + "required": false, "type": "string" }, { - "description": "zone name", - "name": "zonename", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "If true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.", + "length": 255, + "name": "activeonly", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { - "description": "zone ID", - "name": "zoneid", + "description": "the vendor name of the GPU card", + "name": "vendorname", + "type": "string" + }, + { + "description": "the display name of the GPU card", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the device name of the GPU card", + "name": "devicename", + "type": "string" + }, + { + "description": "the ID of the GPU card", + "name": "id", + "type": "string" } ], - "since": "4.14.0" + "since": "4.21.0" }, { "description": "Adds a guest OS name to hypervisor OS name mapping", @@ -90479,16 +98970,16 @@ "name": "addGuestOsMapping", "params": [ { - "description": "OS name specific to the hypervisor", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "osnameforhypervisor", - "required": true, + "name": "osdisplayname", + "required": false, "type": "string" }, { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "description": "OS name specific to the hypervisor", "length": 255, - "name": "hypervisor", + "name": "osnameforhypervisor", "required": true, "type": "string" }, @@ -90509,10 +99000,17 @@ "type": "boolean" }, { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", "length": 255, - "name": "osdisplayname", - "required": false, + "name": "hypervisorversion", + "required": true, + "type": "string" + }, + { + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { @@ -90522,37 +99020,25 @@ "required": false, "since": "4.19.0", "type": "boolean" - }, - { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", - "length": 255, - "name": "hypervisorversion", - "required": true, - "type": "string" } ], "related": "updateGuestOsMapping", "response": [ - { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - }, {}, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the Guest OS type", + "name": "ostypeid", + "type": "string" }, {}, { @@ -90561,23 +99047,28 @@ "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -90589,25 +99080,36 @@ "name": "listVnfTemplates", "params": [ { - "description": "the template name", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "name", + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "length": 255, + "name": "details", "required": false, - "type": "string" + "since": "4.15", + "type": "list" }, { - "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.", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "listall", + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "", + "description": "list templates that can be used to deploy CKS clusters", "length": 255, - "name": "pagesize", + "name": "forcks", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { "description": "List resources by tags (key/value pairs)", @@ -90617,21 +99119,25 @@ "type": "map" }, { - "description": "the template ID", + "description": "", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "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.", "length": 255, - "name": "ids", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "listall", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -90642,21 +99148,12 @@ "type": "uuid" }, { - "description": "the type of the template", + "description": "the template name", "length": 255, - "name": "templatetype", + "name": "name", "required": false, - "since": "4.19.0", "type": "string" }, - { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -90665,24 +99162,17 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "details", + "name": "isvnf", "required": false, - "since": "4.15", - "type": "list" + "since": "4.19.0", + "type": "boolean" }, { - "description": "show removed templates as well", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "showremoved", + "name": "showicon", "required": false, "type": "boolean" }, @@ -90694,11 +99184,13 @@ "type": "boolean" }, { - "description": "the hypervisor for which to restrict the search", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "hypervisor", + "name": "ids", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "string" + "since": "4.9", + "type": "list" }, { "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", @@ -90709,18 +99201,29 @@ "type": "string" }, { - "description": "flag to display the resource image for the templates", + "description": "ID of the extension for the template", "length": 255, - "name": "showicon", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "show removed templates as well", + "length": 255, + "name": "showremoved", "required": false, "type": "boolean" }, { - "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 VM. * 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 a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "the ID of the OS category for the template", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "since": "4.21.0", + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -90731,155 +99234,176 @@ "type": "uuid" }, { - "description": "", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "page", + "name": "showunique", "required": false, - "type": "integer" + "since": "4.13.2", + "type": "boolean" }, { - "description": "list datadisk templates by parent template id", + "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 VM. * 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 a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", "length": 255, - "name": "parenttemplateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "name": "templatefilter", + "required": true, + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "list templates that are ready to be deployed", "length": 255, - "name": "isvnf", + "name": "isready", "required": false, - "since": "4.19.0", + "since": "4.21.0", "type": "boolean" }, { - "description": "If set to true, list only unique templates across zones", + "description": "the type of the template", "length": 255, - "name": "showunique", + "name": "templatetype", "required": false, - "since": "4.13.2", - "type": "boolean" + "since": "4.19.0", + "type": "string" + }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "list templates by zoneId", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, { "description": "the tag of this template", "name": "templatetag", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, - {}, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - {}, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { @@ -90888,47 +99412,43 @@ "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -90937,121 +99457,111 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, { "description": "the name of userdata linked to this template", "name": "userdataname", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the template ID", - "name": "id", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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", + "name": "userdataparams", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { @@ -91060,49 +99570,80 @@ "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "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", - "name": "userdataparams", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, { "description": "checksum of the template", "name": "checksum", "type": "string" }, + {}, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" } ], "since": "4.19.0" @@ -91113,316 +99654,310 @@ "name": "deployVnfAppliance", "params": [ { - "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.", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "bootmode", + "name": "affinitygroupids", + "related": "", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "list" }, { - "description": "an optional user generated name for the virtual machine", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "displayname", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "used to specify the vApp properties.", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "properties", + "name": "bootintosetup", "required": false, - "since": "4.15", - "type": "map" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "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", "length": 255, - "name": "copyimagetags", + "name": "nicnetworklist", "required": false, - "since": "4.13", - "type": "boolean" + "since": "4.15", + "type": "map" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "keyboard", + "required": false, + "type": "string" }, { - "description": "availability zone for the virtual machine", + "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", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "datadiskofferinglist", + "required": false, + "since": "4.11", + "type": "map" }, { - "description": "the ID of the template for the virtual machine", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" }, { - "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.", + "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", "length": 255, - "name": "diskofferingid", + "name": "overridediskofferingid", "related": "", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "nicmultiqueuenumber", - "required": false, - "since": "4.18", - "type": "integer" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "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", "length": 255, - "name": "userdatadetails", + "name": "datadisksdetails", "required": false, - "since": "4.18", + "since": "4.21.0", "type": "map" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", "length": 255, - "name": "affinitygroupids", + "name": "affinitygroupnames", "related": "", "required": false, "type": "list" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "startvm", + "name": "details", "required": false, - "type": "boolean" + "since": "4.3", + "type": "map" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "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.", "length": 255, - "name": "size", + "name": "bootmode", "required": false, - "type": "long" + "since": "4.14.0.0", + "type": "string" }, { - "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", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "overridediskofferingid", - "related": "", + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "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", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "iptonetworklist", "required": false, - "type": "list" + "type": "map" }, { - "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", + "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", "length": 255, - "name": "datadiskofferinglist", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, - "since": "4.11", - "type": "map" + "type": "list" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "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", "length": 255, - "name": "details", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.3", "type": "map" }, { - "description": "host name for the virtual machine", - "length": 255, - "name": "name", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, + "since": "4.12", "type": "string" }, { - "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", - "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.4", - "type": "long" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional group for the virtual machine", "length": 255, - "name": "customid", + "name": "group", "required": false, "type": "string" }, { - "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.", + "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", "length": 255, - "name": "vnfcidrlist", + "name": "securitygroupnames", + "related": "updateSecurityGroup", "required": false, "type": "list" }, { - "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.", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "iothreadsenabled", + "name": "deploymentplanner", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "keyboard", + "name": "account", "required": false, "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "the ip address for default vm's network", "length": 255, - "name": "keypairs", + "name": "ipaddress", "required": false, - "since": "4.17", - "type": "list" + "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "customid", "required": false, - "type": "uuid" + "type": "string" }, { - "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", - "length": 255, - "name": "securitygroupnames", - "related": "updateSecurityGroup", + "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", + "length": 1048576, + "name": "userdata", "required": false, - "type": "list" + "type": "string" }, { - "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", + "description": "Deploy vm for the project", "length": 255, - "name": "hypervisor", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "dynamicscalingenabled", + "name": "leaseexpiryaction", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "the ID of the Userdata", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "userdataid", - "related": "", + "name": "externaldetails", "required": false, - "since": "4.18", - "type": "uuid" + "since": "4.21.0", + "type": "map" }, { - "description": "an optional group for the virtual machine", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "group", + "name": "displayname", "required": false, "type": "string" }, { - "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.", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "boottype", + "name": "keypair", "required": false, - "since": "4.14.0.0", "type": "string" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "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.", "length": 255, - "name": "deploymentplanner", + "name": "diskofferingid", + "related": "", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "account", + "name": "startvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ip address for default vm's network", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "ipaddress", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "the ipv6 address for default vm's network", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "ip6address", + "name": "nicpackedvirtqueuesenabled", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "used to specify the vApp properties.", "length": 255, - "name": "displayvm", + "name": "properties", "required": false, - "since": "4.2", - "type": "boolean" + "since": "4.15", + "type": "map" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "keypair", + "name": "copyimagetags", "required": false, - "type": "string" + "since": "4.13", + "type": "boolean" }, { - "description": "Deploy vm for the project", + "description": "", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, + "since": "4.21", "type": "uuid" }, { - "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", + "description": "Controls specific policies on IO", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "iodriverpolicy", "required": false, - "type": "map" + "type": "string" }, { - "description": "Enable packed virtqueues or not.", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { - "description": "Controls specific policies on IO", + "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", "length": 255, - "name": "iodriverpolicy", + "name": "hypervisor", "required": false, "type": "string" }, @@ -91435,36 +99970,27 @@ "type": "list" }, { - "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", - "length": 1048576, - "name": "userdata", + "description": "host name for the virtual machine", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "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", + "description": "Number of days instance is leased for.", "length": 255, - "name": "securitygroupids", - "related": "updateSecurityGroup", + "name": "leaseduration", "required": false, - "type": "list" + "since": "4.21.0", + "type": "integer" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "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.", "length": 255, - "name": "bootintosetup", + "name": "iothreadsenabled", "required": false, - "since": "4.15.0.0", "type": "boolean" }, - { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", - "type": "string" - }, { "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.", "length": 255, @@ -91473,6 +99999,13 @@ "required": false, "type": "uuid" }, + { + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, + "type": "string" + }, { "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", "length": 255, @@ -91480,6 +100013,39 @@ "required": false, "type": "boolean" }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.2", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "snapshotid", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "required": false, + "since": "4.21", + "type": "uuid" + }, { "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, @@ -91489,43 +100055,145 @@ "type": "string" }, { - "description": "the mac address for default vm's network", + "description": "the ID of the Userdata", "length": 255, - "name": "macaddress", + "name": "userdataid", + "related": "listCniConfiguration", + "required": false, + "since": "4.18", + "type": "uuid" + }, + { + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", "required": false, "type": "string" }, { - "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", + "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", "length": 255, - "name": "iptonetworklist", + "name": "rootdisksize", "required": false, - "type": "map" + "since": "4.4", + "type": "long" }, { - "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", + "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.", "length": 255, - "name": "nicnetworklist", + "name": "vnfcidrlist", "required": false, - "since": "4.15", - "type": "map" + "type": "list" + }, + { + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "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.", + "length": 255, + "name": "boottype", + "required": false, + "since": "4.14.0.0", + "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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", "response": [ { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -91534,454 +100202,281 @@ "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, { "description": "VNF details", "name": "vnfdetails", "type": "map" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + {}, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, + {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, { "description": "the name of the domain in which the virtual machine exists", "name": "domain", "type": "string" }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + {}, { "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -91989,22 +100484,17 @@ "name": "securitygroup", "response": [ { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -92012,148 +100502,123 @@ "name": "cidr", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -92161,48 +100626,53 @@ "name": "cidr", "type": "string" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -92211,13 +100681,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -92226,18 +100696,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", @@ -92247,23 +100717,23 @@ "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -92271,13 +100741,13 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -92286,33 +100756,33 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -92321,172 +100791,379 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, - {}, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { "description": "the ID of the ISO attached to the virtual machine", @@ -92494,119 +101171,93 @@ "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" } ], @@ -92618,25 +101269,25 @@ "name": "updateNetworkOffering", "params": [ { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "the name of the network offering", "length": 255, - "name": "domainid", + "name": "name", "required": false, "type": "string" }, { - "description": "update state for the network offering", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, - "name": "state", + "name": "domainid", "required": false, "type": "string" }, { - "description": "the display text of the network offering", + "description": "sort key of the network offering, integer", "length": 255, - "name": "displaytext", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { "description": "maximum number of concurrent connections supported by the network offering", @@ -92653,26 +101304,19 @@ "type": "string" }, { - "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", - "length": 255, - "name": "availability", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" }, { - "description": "the id of the network offering", - "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "sort key of the network offering, integer", + "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", "length": 255, - "name": "sortkey", + "name": "availability", "required": false, - "type": "integer" + "type": "string" }, { "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", @@ -92682,64 +101326,69 @@ "type": "boolean" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", + "description": "update state for the network offering", + "length": 255, + "name": "state", "required": false, - "since": "4.13", "type": "string" }, { - "description": "the name of the network offering", + "description": "the display text of the network offering", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" + }, + { + "description": "the id of the network offering", + "length": 255, + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" } ], "related": "createNetworkOffering,listNetworkOfferings", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, + { + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, { "description": "the service name", "name": "name", @@ -92749,39 +101398,61 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the provider name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", "type": "boolean" } ], @@ -92791,98 +101462,84 @@ "type": "list" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the id of the network offering", - "name": "id", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, + {}, { "description": "maximum number of concurrents connections to be handled by lb", "name": "maxconnections", "type": "integer" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" + "description": "the tags for the network offering", + "name": "tags", + "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { "description": "guest type of the network offering, can be Shared or Isolated", "name": "guestiptype", "type": "string" }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, { "description": "the date this network offering was created", "name": "created", "type": "date" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { @@ -92891,30 +101548,14 @@ "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, - {}, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" }, { "description": "true if network offering can be used by VPC networks only", @@ -92922,18 +101563,24 @@ "type": "boolean" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, + {}, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { @@ -92941,20 +101588,24 @@ "name": "isdefault", "type": "boolean" }, - {}, { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", - "type": "boolean" + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" } ] @@ -92983,70 +101634,70 @@ "related": "enableOutOfBandManagementForHost", "response": [ { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + {}, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", "type": "powerstate" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host", + "name": "hostid", "type": "string" } ], @@ -93058,39 +101709,40 @@ "name": "listResourceDetails", "params": [ { - "description": "", + "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.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list by key", "length": 255, - "name": "account", + "name": "key", "required": false, "type": "string" }, { - "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.", + "description": "list by resource id", "length": 255, - "name": "listall", + "name": "resourceid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list by resource type", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "resourcetype", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "if set to true, only details marked with display=true, are returned. False by default", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.3", + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -93101,19 +101753,25 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list by resource type", "length": 255, - "name": "isrecursive", + "name": "resourcetype", + "required": true, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -93123,11 +101781,11 @@ "type": "integer" }, { - "description": "list by resource id", + "description": "", "length": 255, - "name": "resourceid", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list by key, value. Needs to be passed only along with key", @@ -93138,88 +101796,81 @@ "type": "string" }, { - "description": "list by key", - "length": 255, - "name": "key", - "required": false, - "type": "string" - }, - { - "description": "if set to true, only details marked with display=true, are returned. False by default", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.3", - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, {}, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, - {}, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, + {}, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], @@ -93231,19 +101882,18 @@ "name": "createNetworkOffering", "params": [ { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "conservemode", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "description": "services supported by the network offering", "length": 255, - "name": "fortungsten", + "name": "supportedservices", "required": false, - "type": "boolean" + "type": "list" }, { "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", @@ -93262,71 +101912,68 @@ "type": "boolean" }, { - "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", - "length": 255, - "name": "serviceproviderlist", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", "length": 255, - "name": "ispersistent", + "name": "fortungsten", "required": false, "type": "boolean" }, { - "description": "services supported by the network offering", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", "length": 255, - "name": "supportedservices", + "name": "ispersistent", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "desired service capabilities as part of network offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "servicecapabilitylist", "required": false, - "since": "4.13", - "type": "list" + "type": "map" }, { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "internetprotocol", + "name": "egressdefaultpolicy", "required": false, - "since": "4.17.0", - "type": "string" + "type": "boolean" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "true if network offering supports choosing AS number", "length": 255, - "name": "maxconnections", + "name": "specifyasnumber", "required": false, - "type": "integer" + "since": "4.20.0", + "type": "boolean" }, { - "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", "length": 255, - "name": "availability", - "required": false, + "name": "traffictype", + "required": true, "type": "string" }, { - "description": "data transfer rate in megabits per second allowed", + "description": "guest type of the network offering: Shared or Isolated", "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" + "name": "guestiptype", + "required": true, + "type": "string" }, { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "description": "true if network offering supports vlans", "length": 255, - "name": "details", + "name": "specifyvlan", "required": false, - "since": "4.2.0", - "type": "map" + "type": "boolean" }, { "description": "true if network offering for NSX network offering supports Load balancer service.", @@ -93337,121 +101984,126 @@ "type": "boolean" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "description": "the name of the network offering", "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the service offering ID used by virtual router provider", + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "serviceproviderlist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "egressdefaultpolicy", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the name of the network offering", + "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", "length": 255, - "name": "name", - "required": true, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "guest type of the network offering: Shared or Isolated", + "description": "data transfer rate in megabits per second allowed", "length": 255, - "name": "guestiptype", - "required": true, - "type": "string" + "name": "networkrate", + "required": false, + "type": "integer" }, { - "description": "desired service capabilities as part of network offering", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "servicecapabilitylist", + "name": "maxconnections", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", "length": 255, - "name": "traffictype", - "required": true, - "type": "string" + "name": "details", + "required": false, + "since": "4.2.0", + "type": "map" }, { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", "length": 255, - "name": "fornsx", + "name": "availability", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "true if the network offering is IP conserve mode enabled", + "description": "Name of the provider providing the service", "length": 255, - "name": "conservemode", + "name": "provider", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "true if network offering for NSX network offering supports Internal Load balancer service.", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "nsxsupportsinternallb", + "name": "networkmode", "required": false, "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "forvpc", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "since": "4.13", + "type": "list" }, { - "description": "true if network offering supports choosing AS number", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "specifyasnumber", + "name": "fornsx", "required": false, "since": "4.20.0", "type": "boolean" }, { - "description": "true if network offering supports vlans", + "description": "true if network offering for NSX network offering supports Internal Load balancer service.", "length": 255, - "name": "specifyvlan", + "name": "nsxsupportsinternallb", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "description": "true if network offering is meant to be used for VPC, false otherwise.", + "length": 255, + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", "length": 255, - "name": "keepaliveenabled", + "name": "specifyipranges", "required": false, "type": "boolean" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "description": "the service offering ID used by virtual router provider", "length": 255, - "name": "networkmode", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.20.0", - "type": "string" + "type": "uuid" }, { "description": "the display text of the network offering, defaults to the value of 'name'.", @@ -93459,75 +102111,75 @@ "name": "displaytext", "required": false, "type": "string" + }, + { + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "length": 255, + "name": "keepaliveenabled", + "required": false, + "type": "boolean" } ], "related": "listNetworkOfferings", "response": [ { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" - }, - {}, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", "type": "boolean" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, - {}, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", "type": "integer" }, { @@ -93535,16 +102187,7 @@ "name": "conservemode", "type": "boolean" }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + {}, { "description": "the list of supported services", "name": "service", @@ -93554,23 +102197,23 @@ "name": "provider", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -93579,9 +102222,9 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "true if individual services can be enabled/disabled", @@ -93601,9 +102244,9 @@ "name": "capability", "response": [ { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { "description": "the capability value", @@ -93611,9 +102254,9 @@ "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the capability name", + "name": "name", + "type": "string" } ], "type": "list" @@ -93622,9 +102265,14 @@ "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" }, { "description": "true if network offering can be used by Tungsten-Fabric networks only", @@ -93632,14 +102280,25 @@ "type": "boolean" }, { - "description": "the id of the network offering", - "name": "id", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + {}, + { + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" }, { "description": "the routing mode for the network offering, supported types are Static or Dynamic.", @@ -93647,14 +102306,14 @@ "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { "description": "true if network offering supports network that span multiple zones", @@ -93662,33 +102321,43 @@ "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { @@ -93697,29 +102366,19 @@ "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", "type": "boolean" - }, - { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "3.0.0" @@ -93729,14 +102388,6 @@ "isasync": true, "name": "dedicateCluster", "params": [ - { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, { "description": "the ID of the containing domain", "length": 255, @@ -93751,50 +102402,58 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" } ], "related": "listDedicatedClusters", "response": [ + {}, + {}, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, - {}, { "description": "the name of the cluster", "name": "clustername", "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Account ID of the cluster", + "name": "accountid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" } ] @@ -93805,12 +102464,11 @@ "name": "createIpForwardingRule", "params": [ { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "description": "the start port for the rule", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "startport", "required": true, - "type": "uuid" + "type": "integer" }, { "description": "the end port for the rule", @@ -93819,6 +102477,13 @@ "required": false, "type": "integer" }, + { + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, { "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", "length": 255, @@ -93827,42 +102492,27 @@ "type": "boolean" }, { - "description": "the protocol for the rule. Valid values are TCP or UDP.", + "description": "the public IP address ID of the forwarding rule, already associated via associateIp", "length": 255, - "name": "protocol", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, - "type": "string" - }, - { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the start port for the rule", + "description": "the protocol for the rule. Valid values are TCP or UDP.", "length": 255, - "name": "startport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" } ], "related": "createPortForwardingRule,updatePortForwardingRule", "response": [ + {}, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { @@ -93870,25 +102520,19 @@ "name": "virtualmachinename", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { @@ -93897,28 +102541,34 @@ "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -93926,18 +102576,18 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -93946,64 +102596,73 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, - {} + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + } ] }, { @@ -94021,25 +102680,36 @@ ], "related": "listElastistorVolume", "response": [ + { + "description": "graceallowed", + "name": "graceallowed", + "type": "string" + }, { "description": "compression", "name": "compression", "type": "string" }, {}, + {}, { - "description": "synchronization", - "name": "sync", + "description": "the id of the volume", + "name": "id", "type": "string" }, { - "description": "the id of the volume", - "name": "id", + "description": "the name of the volume", + "name": "name", "type": "string" }, { - "description": "graceallowed", - "name": "graceallowed", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "synchronization", + "name": "sync", "type": "string" }, { @@ -94051,17 +102721,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the name of the volume", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -94071,18 +102730,11 @@ "name": "quotaStatement", "params": [ { - "description": "Start of the period of the Quota statement. 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.", - "length": 255, - "name": "startdate", - "required": true, - "type": "date" - }, - { - "description": "End of the period of the Quota statement. 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.", + "description": "Optional, Account Id for which statement needs to be generated", "length": 255, - "name": "enddate", + "name": "account", "required": true, - "type": "date" + "type": "string" }, { "description": "List quota usage records for the specified usage type", @@ -94092,36 +102744,39 @@ "type": "integer" }, { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "End of the period of the Quota statement. 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.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "enddate", "required": true, + "type": "date" + }, + { + "description": "List usage records for the specified account", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, "type": "uuid" }, { - "description": "Optional, Account Id for which statement needs to be generated", + "description": "Start of the period of the Quota statement. 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.", "length": 255, - "name": "account", + "name": "startdate", "required": true, - "type": "string" + "type": "date" }, { - "description": "List usage records for the specified account", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", - "required": false, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, "type": "uuid" } ], "related": "", "response": [ - { - "description": "account name", - "name": "account", - "type": "string" - }, + {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -94129,30 +102784,29 @@ "type": "integer" }, { - "description": "usage unit", - "name": "unit", - "type": "string" + "description": "domain id", + "name": "domain", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "usage type name", - "name": "name", + "description": "usage unit", + "name": "unit", "type": "string" }, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" + "description": "account id", + "name": "accountid", + "type": "long" }, { - "description": "domain id", - "name": "domain", - "type": "long" + "description": "account name", + "name": "account", + "type": "string" }, { "description": "usage type", @@ -94160,9 +102814,14 @@ "type": "int" }, { - "description": "account id", - "name": "accountid", - "type": "long" + "description": "quota consumed", + "name": "quota", + "type": "bigdecimal" + }, + { + "description": "usage type name", + "name": "name", + "type": "string" } ], "since": "4.7.0" @@ -94172,14 +102831,6 @@ "isasync": true, "name": "updateLBStickinessPolicy", "params": [ - { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "id of lb stickiness policy", "length": 255, @@ -94188,6 +102839,14 @@ "required": true, "type": "uuid" }, + { + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -94200,8 +102859,8 @@ "related": "createLBStickinessPolicy", "response": [ { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { @@ -94214,8 +102873,13 @@ "name": "stickinesspolicy", "response": [ { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { @@ -94229,9 +102893,9 @@ "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the method name of the Stickiness policy", @@ -94239,36 +102903,38 @@ "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, + {}, + {}, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { @@ -94277,22 +102943,15 @@ "type": "integer" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the state of the policy", - "name": "state", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" - }, - {} + } ], "since": "4.4" }, @@ -94302,53 +102961,54 @@ "name": "listPods", "params": [ { - "description": "List by keyword", + "description": "list pods by allocation state", "length": 255, - "name": "keyword", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "", + "description": "list Pods by name", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list Pods by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the pods", + "description": "list Pods by ID", "length": 255, - "name": "showcapacities", + "name": "id", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list Pods by ID", + "description": "", "length": 255, - "name": "id", - "related": "listPods,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list pods by allocation state", + "description": "the name of the storage access group", "length": 255, - "name": "allocationstate", + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { @@ -94358,38 +103018,70 @@ "related": "listZones", "required": false, "type": "uuid" + }, + { + "description": "flag to display the capacity of the pods", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" } ], "related": "createManagementNetworkIpRange", "response": [ + {}, { "description": "the gateway of the Pod", "name": "gateway", "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the Pod", + "name": "id", + "type": "string" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, - {}, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { @@ -94398,21 +103090,26 @@ "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], "type": "list" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { @@ -94420,39 +103117,39 @@ "name": "endip", "type": "list" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the Pod name", @@ -94465,8 +103162,13 @@ "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { @@ -94475,8 +103177,13 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -94485,8 +103192,8 @@ "type": "short" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], @@ -94498,49 +103205,19 @@ "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, { "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", "name": "vlanid", "type": "list" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", "type": "string" } ] @@ -94568,26 +103245,26 @@ ], "response": [ {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -94597,11 +103274,20 @@ "name": "quotaTariffList", "params": [ { - "description": "Usage type of the resource", + "description": "False will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false.", "length": 255, - "name": "usagetype", + "name": "listall", "required": false, - "type": "integer" + "since": "4.18.0.0", + "type": "boolean" + }, + { + "description": "The name of the quota tariff.", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0.0", + "type": "string" }, { "description": "The start date of the quota tariff. 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.", @@ -94613,31 +103299,37 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "The quota tariff's id.", + "length": 255, + "name": "id", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "False will list only not removed quota tariffs. If set to true, we will list all, including the removed ones. The default is false.", + "description": "If set to true, we will list only the removed tariffs. The default is false.", "length": 255, - "name": "listall", + "name": "listonlyremoved", "required": false, - "since": "4.18.0.0", "type": "boolean" }, { - "description": "List by keyword", + "description": "Usage type of the resource", "length": 255, - "name": "keyword", + "name": "usagetype", "required": false, - "type": "string" + "type": "integer" }, { "description": "The end date of the quota tariff. 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.", @@ -94648,75 +103340,50 @@ "type": "date" }, { - "description": "The name of the quota tariff.", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0.0", - "type": "string" - }, - { - "description": "If set to true, we will list only the removed tariffs. The default is false.", - "length": 255, - "name": "listonlyremoved", - "required": false, - "type": "boolean" - }, - { - "description": "The quota tariff's id.", + "description": "List by keyword", "length": 255, - "name": "id", + "name": "keyword", "required": false, "type": "string" } ], "related": "", "response": [ - { - "description": "usageDiscriminator", - "name": "usageDiscriminator", - "type": "string" - }, - { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" - }, { "description": "position in the execution sequence for tariffs of the same type", "name": "position", "type": "integer" }, - {}, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "description", + "name": "description", "type": "string" }, { - "description": "usageUnit", - "name": "usageUnit", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "description", - "name": "description", - "type": "string" + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "currency", + "name": "currency", + "type": "string" }, { - "description": "name", - "name": "name", - "type": "string" + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "usage type description", - "name": "usageTypeDescription", - "type": "string" + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" }, { "description": "usageName", @@ -94724,19 +103391,23 @@ "type": "string" }, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" }, - {}, { - "description": "usageType", - "name": "usageType", - "type": "int" + "description": "name", + "name": "name", + "type": "string" }, { - "description": "the ID of the tariff", - "name": "id", + "description": "usageUnit", + "name": "usageUnit", + "type": "string" + }, + { + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { @@ -94745,19 +103416,25 @@ "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the tariff", + "name": "id", "type": "string" }, + {}, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "usageType", + "name": "usageType", + "type": "int" }, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" + "description": "usageDiscriminator", + "name": "usageDiscriminator", + "type": "string" } ], "since": "4.7.0" @@ -94783,41 +103460,213 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] + }, + { + "description": "Deletes a vGPU profile from the system", + "isasync": false, + "name": "deleteVgpuProfile", + "params": [ + { + "description": "the ID of the vGPU profile", + "length": 255, + "name": "id", + "related": "createVgpuProfile", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} - ] + ], + "since": "4.21.0" }, { - "description": "Adds account to a project", - "isasync": true, - "name": "addAccountToProject", + "description": "Lists IPv4 subnets for zone.", + "isasync": false, + "name": "listIpv4SubnetsForZone", "params": [ { - "description": "ID of the project to add the account to", + "description": "the domain ID which the IPv4 subnet is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "project who which the IPv4 subnet is dedicated to", "length": 255, "name": "projectid", "related": "createProject", - "required": true, + "required": false, "type": "uuid" }, { - "description": "email to which invitation to the project is going to be sent", + "description": "UUID of zone to which the IPv4 subnet belongs to.", "length": 255, - "name": "email", + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "UUID of the IPv4 subnet.", + "length": 255, + "name": "id", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": false, + "type": "uuid" + }, + { + "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "dedicateIpv4SubnetForZone", + "response": [ + {}, + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" + }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Adds account to a project", + "isasync": true, + "name": "addAccountToProject", + "params": [ + { + "description": "name of the account to be added to the project", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -94830,22 +103679,29 @@ "type": "uuid" }, { - "description": "name of the account to be added to the project", + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "length": 255, + "name": "roletype", + "required": false, + "type": "string" + }, + { + "description": "email to which invitation to the project is going to be sent", "length": 255, - "name": "account", + "name": "email", "required": false, "type": "string" }, { - "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "description": "ID of the project to add the account to", "length": 255, - "name": "roletype", - "required": false, - "type": "string" + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -94856,17 +103712,18 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ], "since": "3.0.0" }, @@ -94885,11 +103742,13 @@ "type": "uuid" }, { - "description": "", + "description": "ID of the storage pool", "length": 255, - "name": "page", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "since": "4.19", + "type": "uuid" }, { "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", @@ -94900,42 +103759,55 @@ "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tags", + "name": "projectid", + "related": "createProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "ID of the storage pool", + "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.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "listall", "required": false, - "since": "4.19", - "type": "uuid" + "type": "boolean" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "", "length": 255, - "name": "intervaltype", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "valid values are MANUAL or RECURRING.", + "length": 255, + "name": "snapshottype", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "If set to false, list templates across zones and their storages", + "length": 255, + "name": "showunique", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "lists snapshot by snapshot ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -94946,41 +103818,34 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "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.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list snapshots by zone id", + "description": "the ID of the disk volume", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, "type": "uuid" }, { - "description": "If set to false, list templates across zones and their storages", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "valid values are MANUAL or RECURRING.", + "description": "lists snapshot by snapshot ID", "length": 255, - "name": "snapshottype", + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the IDs of the snapshots, mutually exclusive with id", @@ -94992,100 +103857,85 @@ "type": "list" }, { - "description": "lists snapshot by snapshot name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "pagesize", + "name": "intervaltype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list snapshots by zone id", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" - }, - { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": false, - "type": "uuid" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" + "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", + "name": "state", + "type": "state" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, - {}, { "description": "type of the disk volume", "name": "volumetype", "type": "string" }, - {}, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { @@ -95094,18 +103944,38 @@ "type": "long" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" + }, + { + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { @@ -95113,238 +103983,190 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, { "description": "the domain ID of the snapshot's account", "name": "domainid", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "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", - "name": "state", - "type": "state" + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, + {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, + {}, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" } ] }, { - "description": "Lists IPv4 subnets for zone.", + "description": "Delete the extensions", "isasync": false, - "name": "listIpv4SubnetsForZone", + "name": "deleteExtension", "params": [ { - "description": "project who which the IPv4 subnet is dedicated to", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, - { - "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the domain ID which the IPv4 subnet is dedicated to.", + "description": "ID of the extension", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "id", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "Whether cleanup entry-point files for the extension", "length": 255, - "name": "keyword", + "name": "cleanup", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, - "type": "string" - }, + "type": "boolean" + } + ], + "related": "listExtensions,updateExtension,unregisterExtension", + "response": [ { - "description": "CIDR of the IPv4 subnet.", - "length": 255, - "name": "subnet", - "required": false, + "description": "Name of the extension", + "name": "name", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" }, { - "description": "UUID of the IPv4 subnet.", - "length": 255, - "name": "id", - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "required": false, - "type": "uuid" - } - ], - "related": "dedicateIpv4SubnetForZone", - "response": [ - { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "Description of the extension", + "name": "description", "type": "string" }, + {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "ID of the extension", + "name": "id", "type": "string" }, { @@ -95353,54 +104175,81 @@ "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", - "type": "string" + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + } + ], + "type": "list" }, { - "description": "the account of the IPv4 subnet", - "name": "account", - "type": "string" + "description": "The details of the extension", + "name": "details", + "type": "map" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, {}, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "The state of the extension", + "name": "state", "type": "string" }, - {}, { - "description": "id of the guest IPv4 subnet", - "name": "id", - "type": "string" + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "Type of the extension", + "name": "type", "type": "string" } ], - "since": "4.20.0" + "since": "4.21.0" }, { "description": "migrates resources from one secondary storage to destination image store", @@ -95408,9 +104257,9 @@ "name": "migrateResourceToAnotherSecondaryStorage", "params": [ { - "description": "id of the image store from where the data is to be migrated", + "description": "id of the destination secondary storage pool to which the resources are to be migrated", "length": 255, - "name": "srcpool", + "name": "destpool", "related": "addSecondaryStorage,listSwifts,addImageStore", "required": true, "type": "uuid" @@ -95427,14 +104276,14 @@ "description": "id(s) of the templates to be migrated", "length": 255, "name": "templates", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "list" }, { - "description": "id of the destination secondary storage pool to which the resources are to be migrated", + "description": "id of the image store from where the data is to be migrated", "length": 255, - "name": "destpool", + "name": "srcpool", "related": "addSecondaryStorage,listSwifts,addImageStore", "required": true, "type": "uuid" @@ -95442,19 +104291,20 @@ ], "related": "migrateSecondaryStorageData", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -95464,11 +104314,10 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.19.0" }, @@ -95478,12 +104327,11 @@ "name": "deleteSSHKeyPair", "params": [ { - "description": "the project associated with keypair", + "description": "the account associated with the keypair. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the domain ID associated with the keypair", @@ -95494,31 +104342,22 @@ "type": "uuid" }, { - "description": "Name of the keypair", + "description": "the project associated with keypair", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the account associated with the keypair. Must be used with the domainId parameter.", + "description": "Name of the keypair", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -95526,10 +104365,20 @@ "type": "integer" }, {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -95552,13 +104401,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "query to search using", "length": 255, @@ -95566,57 +104408,64 @@ "related": "searchLdap", "required": true, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "The user's username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The user's principle", + "name": "principal", + "type": "string" }, - {}, { - "description": "The user's firstname", - "name": "firstname", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", "type": "string" }, { - "description": "The user's email", - "name": "email", + "description": "The user's domain", + "name": "domain", "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -95626,48 +104475,68 @@ "name": "readyForShutdown", "params": [ { - "description": "the uuid of the management server", + "description": "the id of the management server", "length": 255, "name": "managementserverid", "related": "listManagementServers", - "required": false, + "required": true, "type": "uuid" } ], "related": "prepareForShutdown", "response": [ { - "description": "The id of the management server", - "name": "managementserverid", - "type": "string" + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, { "description": "Indicates whether CloudStack is ready to shutdown", "name": "readyforshutdown", "type": "boolean" }, + { + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, {}, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], "since": "4.19.0" }, @@ -95677,59 +104546,59 @@ "name": "createTungstenFabricLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric logical router name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric logical router name", + "description": "the ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "Tungsten-Fabric logical router name", "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { "description": "Tungsten-Fabric logical router uuid", "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" } ] }, @@ -95750,49 +104619,28 @@ "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - {}, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "description of the shared filesystem", - "name": "description", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { @@ -95801,39 +104649,38 @@ "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, - {}, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { @@ -95841,68 +104688,33 @@ "name": "size", "type": "long" }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "ID of the storage fs vm", - "name": "vmstate", - "type": "string" - }, - { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" - }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, { "description": "disk offering for the shared filesystem has custom size", "name": "iscustomdiskoffering", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -95911,63 +104723,63 @@ "type": "boolean" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -95976,8 +104788,8 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { @@ -95985,14 +104797,19 @@ "name": "id", "type": "string" }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", "name": "nsxlogicalswitch", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -96001,91 +104818,56 @@ "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "list" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { @@ -96093,13 +104875,13 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -96108,18 +104890,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -96128,13 +104905,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -96143,36 +104920,73 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, + {}, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { @@ -96181,9 +104995,64 @@ "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" } ], "since": "4.20.0" @@ -96194,17 +105063,10 @@ "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "the uuid of Tungsten-Fabric source network", - "length": 255, - "name": "srcnetworkuuid", - "required": false, - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule source address group uuid", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "srcaddressgroupuuid", - "required": false, + "name": "servicegroupuuid", + "required": true, "type": "string" }, { @@ -96215,46 +105077,40 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group uuid", - "length": 255, - "name": "destaddressgroupuuid", - "required": false, - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule service group uuid", + "description": "the ID of zone", "length": 255, - "name": "servicegroupuuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "desttaguuid", - "required": false, + "name": "firewallpolicyuuid", + "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric destination network", + "description": "the uuid of Tungsten-Fabric source network", "length": 255, - "name": "destnetworkuuid", + "name": "srcnetworkuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", + "description": "Tungsten-Fabric firewall rule destination address group uuid", "length": 255, - "name": "srctaguuid", + "name": "destaddressgroupuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "the sequence of Tungsten-Fabric firewall rule", "length": 255, - "name": "firewallpolicyuuid", + "name": "sequence", "required": true, - "type": "string" + "type": "integer" }, { "description": "Tungsten-Fabric firewall rule name", @@ -96271,59 +105127,67 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric firewall rule source address group uuid", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "srcaddressgroupuuid", + "required": false, + "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall rule", + "description": "Tungsten-Fabric firewall rule tag type uuid", "length": 255, - "name": "sequence", - "required": true, - "type": "integer" + "name": "tagtypeuuid", + "required": false, + "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type uuid", + "description": "the uuid of Tungsten-Fabric destination network", "length": 255, - "name": "tagtypeuuid", + "name": "destnetworkuuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination tag uuid", + "length": 255, + "name": "desttaguuid", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source tag uuid", + "length": 255, + "name": "srctaguuid", "required": false, "type": "string" } ], "related": "listTungstenFabricFirewallRule", "response": [ - { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, {}, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { @@ -96331,51 +105195,56 @@ "name": "srcaddressgroup", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, @@ -96385,24 +105254,25 @@ "name": "listConfigurations", "params": [ { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "lists configuration by parent name (primarily used for UI)", "length": 255, - "name": "keyword", + "name": "parent", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "lists configuration by parent name (primarily used for UI)", + "description": "lists configuration by subgroup name (primarily used for UI)", "length": 255, - "name": "parent", + "name": "subgroup", "required": false, "since": "4.18.0", "type": "string" @@ -96416,19 +105286,11 @@ "type": "string" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,addImageStore", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the Account to update the parameter value for corresponding account", @@ -96439,19 +105301,18 @@ "type": "uuid" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", + "description": "lists configurations by category", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "category", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "lists configuration by name", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the Zone to update the parameter value for corresponding zone", @@ -96462,18 +105323,27 @@ "type": "uuid" }, { - "description": "lists configuration by name", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "name", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists configurations by category", + "description": "", "length": 255, - "name": "category", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the ID of the Domain to update the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", @@ -96484,26 +105354,24 @@ "type": "uuid" }, { - "description": "lists configuration by subgroup name (primarily used for UI)", + "description": "", "length": 255, - "name": "subgroup", + "name": "page", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the description of the configuration", - "name": "description", + "description": "the value of the configuration", + "name": "value", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", @@ -96511,39 +105379,43 @@ "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the group of the configuration", + "name": "group", "type": "string" }, - {}, { "description": "the default value of the configuration", "name": "defaultvalue", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the description of the configuration", + "name": "description", + "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the value of the configuration", + "name": "id", + "type": "long" + }, + { + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { @@ -96551,36 +105423,33 @@ "name": "displaytext", "type": "string" }, + {}, { - "description": "the name of the parent configuration", - "name": "parent", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the value of the configuration", - "name": "id", - "type": "long" - } + {} ] }, { @@ -96589,12 +105458,11 @@ "name": "scaleKubernetesCluster", "params": [ { - "description": "the IDs of the nodes to be removed", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "nodeids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "name": "size", "required": false, - "type": "list" + "type": "long" }, { "description": "the ID of the service offering for the virtual machines in the cluster.", @@ -96604,6 +105472,14 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, + "type": "uuid" + }, { "description": "Minimum number of worker nodes in the cluster", "length": 255, @@ -96612,157 +105488,182 @@ "type": "long" }, { - "description": "Whether autoscaling is enabled for the cluster", + "description": "Maximum number of worker nodes in the cluster", "length": 255, - "name": "autoscalingenabled", + "name": "maxsize", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "Maximum number of worker nodes in the cluster", + "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", "length": 255, - "name": "maxsize", + "name": "nodeofferings", "required": false, - "type": "long" + "since": "4.21.0", + "type": "map" }, { - "description": "number of Kubernetes cluster nodes", + "description": "the IDs of the nodes to be removed", "length": 255, - "name": "size", + "name": "nodeids", + "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", "required": false, - "type": "long" + "type": "list" }, { - "description": "the ID of the Kubernetes cluster", + "description": "Whether autoscaling is enabled for the cluster", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "required": true, - "type": "uuid" + "name": "autoscalingenabled", + "required": false, + "type": "boolean" } ], "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", + "type": "string" }, - {}, { "description": "the account associated with the Kubernetes cluster", "name": "account", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, + {}, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { "description": "keypair details", "name": "keypair", "type": "string" }, + { + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" + }, { "description": "the name of the service offering of the Kubernetes cluster", "name": "serviceofferingname", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { @@ -96771,69 +105672,95 @@ "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, + { + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, { "description": "Public IP Address ID of the cluster", "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" + }, + { + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" } ] }, @@ -96860,45 +105787,30 @@ ], "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ + {}, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { @@ -96907,18 +105819,18 @@ "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { @@ -96926,84 +105838,24 @@ "name": "ip6dns1", "type": "string" }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, { "description": "the control state of the host for the router", "name": "hostcontrolstate", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -97012,89 +105864,28 @@ "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - {}, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { @@ -97102,14 +105893,19 @@ "name": "nic", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { "description": "the ID of the corresponding network", @@ -97122,24 +105918,24 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { "description": "public IP address id associated with this nic via Static nat rule", @@ -97147,29 +105943,29 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { "description": "the type of the nic", @@ -97177,132 +105973,208 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" } ], "type": "set" }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, { "description": "the name of the corresponding guest network", "name": "guestnetworkname", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { "description": "Last executed health check result for the router", "name": "healthcheckresults", "response": [ + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, { "description": "result of the health check", "name": "success", "type": "boolean" }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, { "description": "the type of the health check - basic or advanced", "name": "checktype", @@ -97314,22 +106186,77 @@ "type": "date" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], "type": "list" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, { "description": "the name of VPC the router belongs to", "name": "vpcname", "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -97348,28 +106275,28 @@ } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ] }, { @@ -97378,30 +106305,37 @@ "name": "updateTrafficType", "params": [ { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "xennetworklabel", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "kvmnetworklabel", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "hypervnetworklabel", + "name": "ovm3networklabel", "required": false, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "ovm3networklabel", + "name": "xennetworklabel", + "required": false, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "length": 255, + "name": "kvmnetworklabel", "required": false, "type": "string" }, @@ -97412,27 +106346,11 @@ "related": "addTrafficType,updateTrafficType", "required": true, "type": "uuid" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "length": 255, - "name": "vmwarenetworklabel", - "required": false, - "type": "string" } ], "related": "addTrafficType", "response": [ - { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "id of the network provider", "name": "id", @@ -97444,18 +106362,13 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", - "type": "string" - }, - { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, {}, @@ -97464,17 +106377,31 @@ "name": "hypervnetworklabel", "type": "string" }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", + "type": "string" + }, { "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "name": "kvmnetworklabel", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, - {} + { + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -97483,14 +106410,6 @@ "isasync": false, "name": "listConditions", "params": [ - { - "description": "Counter-id of the condition.", - "length": 255, - "name": "counterid", - "related": "createCounter", - "required": false, - "type": "uuid" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -97500,12 +106419,11 @@ "type": "uuid" }, { - "description": "ID of the Condition.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listConditions", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -97515,6 +106433,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "the ID of the policy", "length": 255, @@ -97524,11 +106449,11 @@ "type": "uuid" }, { - "description": "", + "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.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -97537,13 +106462,6 @@ "required": false, "type": "string" }, - { - "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.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -97554,28 +106472,37 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Counter-id of the condition.", "length": 255, - "name": "isrecursive", + "name": "counterid", + "related": "createCounter", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "ID of the Condition.", + "length": 255, + "name": "id", + "related": "listConditions", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, { @@ -97585,8 +106512,8 @@ }, {}, { - "description": "the project name of the Condition", - "name": "project", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { @@ -97595,23 +106522,19 @@ "type": "counterresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the Id of the Counter.", "name": "counterid", "type": "string" }, { - "description": "the id of the Condition", - "name": "id", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { @@ -97620,30 +106543,34 @@ "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the id of the Condition", + "name": "id", "type": "string" }, - {}, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "the Name of the Counter.", + "name": "countername", + "type": "string" }, { "description": "the domain name of the owner.", "name": "domain", "type": "string" + }, + { + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", + "type": "string" } ] }, @@ -97653,9 +106580,9 @@ "name": "addBackupRepository", "params": [ { - "description": "type of the backup repository storage. Supported values: nfs, cephfs, cifs", + "description": "address of the backup repository", "length": 255, - "name": "type", + "name": "address", "required": true, "type": "string" }, @@ -97667,12 +106594,11 @@ "type": "string" }, { - "description": "ID of the zone where the backup repository is to be added", + "description": "shared storage mount options", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "mountopts", + "required": false, + "type": "string" }, { "description": "capacity of this backup repository", @@ -97682,18 +106608,19 @@ "type": "long" }, { - "description": "shared storage mount options", + "description": "type of the backup repository storage. Supported values: nfs, cephfs, cifs", "length": 255, - "name": "mountopts", - "required": false, + "name": "type", + "required": true, "type": "string" }, { - "description": "address of the backup repository", + "description": "ID of the zone where the backup repository is to be added", "length": 255, - "name": "address", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "name of the backup repository", @@ -97705,15 +106632,9 @@ ], "related": "", "response": [ - {}, - { - "description": "the Zone name of the backup repository", - "name": "zonename", - "type": "string" - }, { - "description": "backup type", - "name": "type", + "description": "the Zone ID of the backup repository", + "name": "zoneid", "type": "string" }, { @@ -97722,13 +106643,18 @@ "type": "integer" }, { - "description": "the address / url of the backup repository", - "name": "address", + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" + }, + { + "description": "backup type", + "name": "type", "type": "string" }, { - "description": "the ID of the backup repository", - "name": "id", + "description": "the address / url of the backup repository", + "name": "address", "type": "string" }, { @@ -97736,20 +106662,19 @@ "name": "name", "type": "string" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "the Zone name of the backup repository", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the backup repository", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the backup repository", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -97757,10 +106682,12 @@ "name": "created", "type": "date" }, + {}, + {}, { - "description": "capacity of the backup repository", - "name": "capacitybytes", - "type": "long" + "description": "name of the provider", + "name": "provider", + "type": "string" } ], "since": "4.20.0" @@ -97771,12 +106698,11 @@ "name": "migrateSecondaryStorageData", "params": [ { - "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", + "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", "length": 255, - "name": "destpools", - "related": "addSecondaryStorage,listSwifts,addImageStore", - "required": true, - "type": "list" + "name": "migrationtype", + "required": false, + "type": "string" }, { "description": "id of the image store from where the data is to be migrated", @@ -97787,42 +106713,43 @@ "type": "uuid" }, { - "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", + "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", "length": 255, - "name": "migrationtype", - "required": false, - "type": "string" + "name": "destpools", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "list" } ], "related": "", "response": [ { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Response message from migration of secondary storage data objects", + "name": "message", "type": "string" - } + }, + {} ], "since": "4.15.0" }, @@ -97831,14 +106758,6 @@ "isasync": true, "name": "destroyVolume", "params": [ - { - "description": "The ID of the volume", - "length": 255, - "name": "id", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" - }, { "description": "If true is passed, the volume is expunged immediately. False by default.", "length": 255, @@ -97846,64 +106765,103 @@ "required": false, "since": "4.6.0", "type": "boolean" + }, + { + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" } ], "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "name of the disk volume", - "name": "name", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, {}, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, { "description": "the format of the disk encryption if applicable", "name": "encryptformat", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, + {}, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { @@ -97912,58 +106870,73 @@ "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "size of the disk volume", - "name": "size", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { @@ -97972,13 +106945,13 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -97987,89 +106960,108 @@ "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, - {}, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { @@ -98077,13 +107069,18 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -98092,13 +107089,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -98107,13 +107104,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -98122,156 +107119,86 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the state of the disk volume", - "name": "state", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" } ], @@ -98283,38 +107210,37 @@ "name": "addTrafficType", "params": [ { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "ovm3networklabel", + "name": "hypervnetworklabel", "required": false, "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "vlan", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "physicalnetworkid", - "related": "updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "ovm3networklabel", + "required": false, + "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "vmwarenetworklabel", + "name": "vlan", "required": false, "type": "string" }, { - "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "isolationmethod", + "name": "kvmnetworklabel", "required": false, "type": "string" }, @@ -98326,23 +107252,24 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "hypervnetworklabel", - "required": false, + "name": "traffictype", + "required": true, "type": "string" }, { - "description": "the trafficType to be added to the physical network", + "description": "the Physical Network ID", "length": 255, - "name": "traffictype", + "name": "physicalnetworkid", + "related": "updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", "length": 255, - "name": "kvmnetworklabel", + "name": "isolationmethod", "required": false, "type": "string" } @@ -98350,8 +107277,8 @@ "related": "", "response": [ { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { @@ -98360,24 +107287,19 @@ "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, {}, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", - "type": "string" - }, - { - "description": "id of the network provider", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, { @@ -98386,19 +107308,24 @@ "type": "integer" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "id of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" } ], @@ -98410,18 +107337,26 @@ "name": "listSecondaryStorageSelectors", "params": [ { - "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "The zone ID to be used in the search filter.", "length": 255, - "name": "type", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "page", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -98431,12 +107366,11 @@ "type": "integer" }, { - "description": "The zone ID to be used in the search filter.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { "description": "Show removed heuristics.", @@ -98444,27 +107378,14 @@ "name": "showremoved", "required": false, "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", + "type": "string" }, { "description": "When the heuristic was created.", @@ -98472,36 +107393,42 @@ "type": "date" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + }, + { + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, + {}, { "description": "Description of the heuristic.", "name": "description", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { "description": "Name of the heuristic.", "name": "name", "type": "string" }, - {}, { - "description": "ID of the heuristic.", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", "name": "heuristicrule", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -98516,18 +107443,19 @@ "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "description": "", "length": 255, - "name": "applied", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "the ID of the load balancer rule", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", + "required": true, + "type": "uuid" }, { "description": "true if load balancer rule VM IP information to be included; default is false", @@ -98537,52 +107465,51 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, - "name": "keyword", + "name": "applied", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" } ], "related": "listLoadBalancerRuleInstances", "response": [ - {}, + { + "description": "IP addresses of the vm set of lb rule", + "name": "lbvmipaddresses", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the user vm set for lb rule", "name": "loadbalancerruleinstance", "type": "uservmresponse" }, - { - "description": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -98600,27 +107527,27 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -98630,12 +107557,11 @@ "name": "updatePhysicalNetwork", "params": [ { - "description": "physical network id", + "description": "Enabled/Disabled", "length": 255, - "name": "id", - "related": "updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "state", + "required": false, + "type": "string" }, { "description": "the speed for the physical network[1G/10G]", @@ -98652,35 +107578,32 @@ "type": "string" }, { - "description": "Tag the physical network", + "description": "physical network id", "length": 255, - "name": "tags", - "required": false, - "type": "list" + "name": "id", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "Enabled/Disabled", + "description": "Tag the physical network", "length": 255, - "name": "state", + "name": "tags", "required": false, - "type": "string" + "type": "list" } ], "related": "", "response": [ { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" - }, - { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "comma separated tag", + "name": "tags", "type": "string" }, + {}, { - "description": "name of the physical network", - "name": "name", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { @@ -98689,14 +107612,13 @@ "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, - {}, { - "description": "the uuid of the physical network", - "name": "id", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { @@ -98704,35 +107626,40 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "state of the physical network", + "name": "state", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "name of the physical network", + "name": "name", "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" } ], @@ -98743,13 +107670,6 @@ "isasync": true, "name": "stopSharedFileSystem", "params": [ - { - "description": "Force stop the shared filesystem.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "the ID of the shared filesystem", "length": 255, @@ -98757,99 +107677,248 @@ "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": true, "type": "uuid" + }, + { + "description": "Force stop the shared filesystem.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" }, { "description": "the account associated with the shared filesystem", "name": "account", "type": "string" }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + {}, { "description": "the state of the shared filesystem", "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, - {}, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, {}, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -98858,9 +107927,9 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the isolation uri of the nic", @@ -98868,13 +107937,8 @@ "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -98883,23 +107947,38 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -98913,29 +107992,34 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the cidr of IPv6 network", @@ -98943,24 +108027,19 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "device id for the network when plugged into the virtual machine", @@ -98973,232 +108052,230 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" } ], "type": "list" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the write (IO) of disk on the shared filesystem", "name": "diskiowrite", "type": "long" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Creates a vGPU profile in the system", + "isasync": false, + "name": "createVgpuProfile", + "params": [ { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "the name of the vGPU profile", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the GPU card ID associated with this GPU device", + "length": 255, + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the maximum Y resolution", + "length": 255, + "name": "maxresolutiony", + "required": false, + "type": "long" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the description of the vGPU profile", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the maximum X resolution", + "length": 255, + "name": "maxresolutionx", + "required": false, + "type": "long" }, { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" + "description": "the video RAM size in MB", + "length": 255, + "name": "videoram", + "required": false, + "type": "long" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "the maximum number of display heads", + "length": 255, + "name": "maxheads", + "required": false, + "type": "long" + }, + { + "description": "Max vGPU per physical GPU. This is used to calculate capacity.", + "length": 255, + "name": "maxvgpuperphysicalgpu", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, + {}, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, + {}, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the vGPU profile", + "name": "gpucardname", + "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", + "type": "long" + }, + { + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the description of the vGPU profile", + "name": "description", "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" } ], - "since": "4.20.0" + "since": "4.21.0" }, { "description": "create Tungsten-Fabric management network", @@ -99215,7 +108292,6 @@ } ], "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -99226,6 +108302,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -99245,33 +108322,33 @@ "name": "listTungstenFabricFirewallRule", "params": [ { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "", "length": 255, - "name": "firewallpolicyuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "firewallruleuuid", + "name": "firewallpolicyuuid", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "firewallruleuuid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -99290,6 +108367,16 @@ ], "related": "", "response": [ + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Tungsten-Fabric firewall rule direction", "name": "direction", @@ -99300,14 +108387,10 @@ "name": "destnetwork", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { @@ -99316,19 +108399,18 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { @@ -99337,19 +108419,18 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { @@ -99358,27 +108439,122 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, + {} + ] + }, + { + "description": "list all Netris providers added to CloudStack", + "isasync": false, + "name": "listNetrisProviders", + "params": [ { - "description": "Tungsten-Fabric firewall rule uuid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "deleteNetrisProvider", + "response": [ + { + "description": "Netris provider uuid", "name": "uuid", "type": "string" }, + { + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "Netris Admin tenant name", + "name": "tenantname", + "type": "string" + }, + { + "description": "Netris Provider name", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Netris Tag for vNets", + "name": "netristag", + "type": "string" + }, + { + "description": "Netris Provider site", + "name": "sitename", + "type": "string" + }, + { + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", + "type": "string" + }, + {}, + {}, + { + "description": "Netris Provider URL", + "name": "netrisurl", + "type": "string" } - ] + ], + "since": "4.21.0" }, { "description": "Creates a project", "isasync": true, "name": "createProject", "params": [ + { + "description": "account who will be Admin for the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", "length": 255, @@ -99389,63 +108565,257 @@ "type": "uuid" }, { - "description": "domain ID of the account owning a project", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "The display text of the project, defaults to the 'name´.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "ID of the account owning a project", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "domain ID of the account owning a project", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "name of the project", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", + "type": "string" + }, + {}, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "ID of the account owning a project", - "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", - "required": false, - "type": "uuid" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "The display text of the project, defaults to the 'name´.", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "account who will be Admin for the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "name of the project", - "length": 255, - "name": "name", - "required": true, + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the account name of the project's owners", - "name": "owner", + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", "type": "list" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { @@ -99458,13 +108828,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -99473,8 +108838,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -99483,13 +108848,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -99503,21 +108868,21 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { @@ -99526,14 +108891,14 @@ "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" }, { "description": "the total number of templates which have been created by this project", @@ -99541,195 +108906,74 @@ "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the name of the project", + "name": "name", "type": "string" }, + {}, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the total number of gpus owned by project", + "name": "gputotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { "description": "the total number of vpcs the project can own", "name": "vpclimit", "type": "string" }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - {}, { "description": "the state of the project", "name": "state", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - {}, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" } ], @@ -99759,25 +109003,25 @@ ], "response": [ {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -99796,16 +109040,16 @@ "type": "uuid" }, { - "description": "Credentials to access the Cisco VNMC Controller API", + "description": "Hostname or ip address of the Cisco VNMC Controller.", "length": 255, - "name": "username", + "name": "hostname", "required": true, "type": "string" }, { - "description": "Hostname or ip address of the Cisco VNMC Controller.", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "hostname", + "name": "username", "required": true, "type": "string" }, @@ -99819,7 +109063,6 @@ ], "related": "listCiscoVnmcResources", "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -99830,6 +109073,7 @@ {}, {}, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -99843,6 +109087,14 @@ "isasync": true, "name": "markDefaultZoneForAccount", "params": [ + { + "description": "The Zone ID with which the account is to be marked.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "Name of the account that is to be marked.", "length": 255, @@ -99858,96 +109110,33 @@ "related": "createDomain,listDomains,listDomains", "required": true, "type": "uuid" - }, - { - "description": "The Zone ID with which the account is to be marked.", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" } ], "related": "disableAccount,enableAccount,updateAccount,listAccounts", "response": [ { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { @@ -99956,174 +109145,110 @@ "type": "apikeyaccess" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, + {}, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { @@ -100131,63 +109256,83 @@ "name": "user", "response": [ { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { "description": "the account name of the user", "name": "account", "type": "string" }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, { "description": "the domain ID of the user", "name": "domainid", "type": "string" }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, { "description": "the user lastname", "name": "lastname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the user ID", - "name": "id", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -100196,8 +109341,8 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -100206,48 +109351,28 @@ "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, { "description": "the name of the role", "name": "rolename", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -100259,24 +109384,63 @@ "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { @@ -100285,13 +109449,38 @@ "type": "long" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { @@ -100300,75 +109489,152 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" - } - ], - "since": "4.0" - }, - { - "description": "Revokes certificate using configured CA plugin", - "isasync": true, - "name": "revokeCertificate", - "params": [ + }, { - "description": "The certificate serial number, as a hex value", - "length": 255, - "name": "serial", - "required": true, + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "The certificate CN", - "length": 255, - "name": "cn", - "required": false, + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" - } - ], - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the role", + "name": "rolename", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", "type": "boolean" }, - {} + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + } ], - "since": "4.11.0" + "since": "4.0" }, { "description": "Deletes a routing firewall rule", @@ -100385,18 +109651,59 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Revokes certificate using configured CA plugin", + "isasync": true, + "name": "revokeCertificate", + "params": [ + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "The certificate serial number, as a hex value", + "length": 255, + "name": "serial", + "required": true, "type": "string" }, + { + "description": "The certificate CN", + "length": 255, + "name": "cn", + "required": false, + "type": "string" + } + ], + "response": [ { "description": "true if operation is executed successfully", "name": "success", @@ -100406,15 +109713,35 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ], - "since": "4.20.0" + "since": "4.11.0" }, { "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, "name": "changeServiceForSystemVm", "params": [ + { + "description": "The ID of the system vm", + "length": 255, + "name": "id", + "related": "startSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" + }, { "description": "the service offering ID to apply to the system vm", "length": 255, @@ -100429,57 +109756,64 @@ "name": "details", "required": false, "type": "map" - }, - { - "description": "The ID of the system vm", - "length": 255, - "name": "id", - "related": "startSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" } ], "related": "startSystemVm", "response": [ - {}, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the systemvm agent version", + "name": "version", + "type": "string" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, + {}, { "description": "the ID of the service offering of the system virtual machine.", "name": "serviceofferingid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "CPU arch of the system VM", + "name": "arch", + "type": "string" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { @@ -100488,64 +109822,60 @@ "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the last disconnected date of host", "name": "disconnected", "type": "date" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the name of the service offering of the system virtual machine.", "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the system VM", - "name": "name", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, + {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { "description": "the agent state of the system VM", @@ -100553,63 +109883,48 @@ "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { @@ -100618,44 +109933,38 @@ "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, - {}, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" } ] @@ -100666,11 +109975,12 @@ "name": "updateSiocInfo", "params": [ { - "description": "Shares per GB", + "description": "Zone ID", "length": 255, - "name": "sharespergb", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "integer" + "type": "uuid" }, { "description": "Notify if IOPS above this value", @@ -100680,19 +109990,18 @@ "type": "integer" }, { - "description": "Limit IOPS per GB", + "description": "Shares per GB", "length": 255, - "name": "limitiopspergb", + "name": "sharespergb", "required": true, "type": "integer" }, { - "description": "Zone ID", + "description": "Limit IOPS per GB", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "limitiopspergb", "required": true, - "type": "uuid" + "type": "integer" }, { "description": "Storage Pool ID", @@ -100705,92 +110014,291 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "The return message from the operation ('Success' if successful)", "name": "msg", "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.11.0" }, { - "description": "Generates single-sign-on login url for logged-in CloudStack user to access the Cloudian Management Console", - "isasync": false, - "name": "cloudianSsoLogin", - "params": [], - "related": "", + "description": "Deletes a vmsnapshot.", + "isasync": true, + "name": "deleteVMSnapshot", + "params": [ + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], "response": [ { - "description": "the sso redirect url", - "name": "url", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], - "since": "4.11.0" + "since": "4.2.0" }, { - "description": "Deletes a vmsnapshot.", - "isasync": true, - "name": "deleteVMSnapshot", + "description": "Lists console sessions.", + "isasync": false, + "name": "listConsoleSessions", "params": [ { - "description": "The ID of the VM snapshot", + "description": "The domain ID of the account that created the console endpoint.", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "IP address of the creator of the console endpoint.", + "length": 255, + "name": "consoleendpointcreatoraddress", + "required": false, + "type": "string" + }, + { + "description": "The ID of the user that created the console endpoint.", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the virtual machine.", + "length": 255, + "name": "virtualmachineid", + "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", + "required": false, + "type": "uuid" + }, + { + "description": "Lists console sessions from the specified host.", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "Lists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.", + "length": 255, + "name": "activeonly", + "required": false, + "type": "boolean" + }, + { + "description": "The ID of the console session.", + "length": 255, + "name": "id", + "related": "listConsoleSessions", + "required": false, + "type": "uuid" + }, + { + "description": "IP address of the client that accessed the console session.", + "length": 255, + "name": "clientaddress", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "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.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "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.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "The ID of the account that created the console endpoint.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, "type": "uuid" + }, + { + "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.", + "length": 255, + "name": "acquired", + "required": false, + "type": "boolean" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "ID of the account that created the console endpoint.", + "name": "accountid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Domain of the account that created the console endpoint.", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Domain ID of the account that created the console endpoint.", + "name": "domainid", + "type": "string" + }, + { + "description": "Domain path of the account that created the console endpoint.", + "name": "domainpath", + "type": "string" + }, + { + "description": "User that created the console endpoint.", + "name": "user", "type": "string" }, + { + "description": "Date when the console session was acquired.", + "name": "acquired", + "type": "date" + }, {}, + { + "description": "Date when the console session's endpoint was created.", + "name": "created", + "type": "date" + }, + { + "description": "ID of the virtual machine.", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Date when the console session was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "IP address of the creator of the console endpoint.", + "name": "consoleendpointcreatoraddress", + "type": "string" + }, + { + "description": "IP address of the client that created the console session.", + "name": "clientaddress", + "type": "string" + }, + { + "description": "ID of the console session.", + "name": "id", + "type": "string" + }, + { + "description": "Name of the virtual machine.", + "name": "virtualmachinename", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "ID of the host.", + "name": "hostid", + "type": "string" + }, + {}, + { + "description": "Account that created the console endpoint.", + "name": "account", + "type": "string" + }, + { + "description": "ID of the user that created the console endpoint.", + "name": "userid", + "type": "string" + }, + { + "description": "Name of the host.", + "name": "hostname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], - "since": "4.2.0" + "since": "4.21.0" }, { "description": "Unmanage a guest virtual machine.", @@ -100801,7 +110309,7 @@ "description": "The ID of the virtual machine to unmanage", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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", "required": true, "type": "uuid" } @@ -100813,6 +110321,12 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "details of the unmanage VM operation", + "name": "details", + "type": "string" + }, + {}, { "description": "result of the unmanage VM operation", "name": "success", @@ -100823,13 +110337,7 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "details of the unmanage VM operation", - "name": "details", - "type": "string" - }, - {} + } ], "since": "4.15.0" }, @@ -100858,28 +110366,55 @@ "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the id of the router", - "name": "id", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { @@ -100887,40 +110422,65 @@ "name": "projectid", "type": "string" }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, { "description": "the domain associated with the router", "name": "domain", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the name of the router", + "name": "name", + "type": "string" }, + {}, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -100929,18 +110489,18 @@ "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { @@ -100949,114 +110509,134 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { @@ -101065,55 +110645,28 @@ "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - } - ], - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { @@ -101121,73 +110674,73 @@ "name": "nic", "response": [ { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -101196,9 +110749,9 @@ "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the ID of the corresponding network", @@ -101211,122 +110764,77 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" } ], "type": "set" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" } ] }, @@ -101335,22 +110843,6 @@ "isasync": false, "name": "listNics", "params": [ - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the nic to list IPs", - "length": 255, - "name": "nicid", - "related": "listNics", - "required": false, - "type": "uuid" - }, { "description": "list nic of the specific vm's network", "length": 255, @@ -101360,33 +110852,49 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of the nic to list IPs", "length": 255, - "name": "page", + "name": "nicid", + "related": "listNics", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the ID of the vm", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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", "required": true, "type": "uuid" }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "", "length": 255, "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", @@ -101396,21 +110904,98 @@ "name": "ipaddress", "type": "string" }, + {}, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, { "description": "the cidr of IPv6 network", "name": "ip6cidr", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + {}, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, { "description": "device id for the network when plugged into the virtual machine", "name": "deviceid", "type": "string" }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, { "description": "the name of the corresponding network", "name": "networkname", "type": "string" }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", @@ -101421,144 +111006,223 @@ "name": "publicip", "type": "string" }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the ID of the nic", "name": "id", "type": "string" }, - {}, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + } + ] + }, + { + "description": "List user data for CNI plugins", + "isasync": false, + "name": "listCniConfiguration", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "listCniConfiguration", + "required": false, + "type": "uuid" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Userdata name to look for", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "ID of the User Data", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the owner id of the User Data", + "name": "accountid", + "type": "string" }, + {}, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the domain id of the User Data owner", + "name": "domainid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name of the User Data", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the User Data owner", + "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "base64 encoded User Data content", + "name": "userdata", "type": "string" }, - {}, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the owner of the User Data", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Name of the User Data", + "name": "name", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the type of the nic", - "name": "type", + "description": "the project id of the User Data", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "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", + "name": "params", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the domain to which the User Data owner belongs", + "name": "domainpath", + "type": "string" } - ] + ], + "since": "4.21.0" }, { "description": "Lists Bgp Peers.", @@ -101566,55 +111230,48 @@ "name": "listBgpPeers", "params": [ { - "description": "AS number of the Bgp Peer.", - "length": 255, - "name": "asnumber", - "required": false, - "type": "long" - }, - { - "description": "", + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "UUID of the Bgp Peer.", + "description": "the domain ID which the Bgp Peer is dedicated to.", "length": 255, - "name": "id", - "related": "listBgpPeers,releaseBgpPeer", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.", "length": 255, - "name": "keyword", + "name": "isdedicated", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.", + "description": "project who which the Bgp Peer is dedicated to", "length": 255, - "name": "isdedicated", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the domain ID which the Bgp Peer is dedicated to.", + "description": "AS number of the Bgp Peer.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "asnumber", "required": false, - "type": "uuid" + "type": "long" }, { "description": "UUID of zone to which the Bgp Peer belongs to.", @@ -101625,13 +111282,20 @@ "type": "uuid" }, { - "description": "project who which the Bgp Peer is dedicated to", + "description": "UUID of the Bgp Peer.", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "listBgpPeers,releaseBgpPeer", "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -101642,66 +111306,72 @@ ], "related": "releaseBgpPeer", "response": [ + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, { "description": "the project id of the bgp peer", "name": "projectid", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "the account of the bgp peer", + "name": "account", + "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { "description": "date when this bgp peer was created.", @@ -101709,19 +111379,13 @@ "type": "date" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - { - "description": "the project name of the bgp peer", - "name": "project", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the account of the bgp peer", - "name": "account", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" } ], @@ -101740,6 +111404,13 @@ "required": true, "type": "uuid" }, + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "The ID of the disk volume", "length": 255, @@ -101747,36 +111418,29 @@ "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" - }, - { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "the status of the template", - "name": "status", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { "description": "the type of the snapshot", @@ -101784,8 +111448,8 @@ "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { @@ -101794,65 +111458,53 @@ "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, - {}, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -101865,28 +111517,28 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -101894,6 +111546,11 @@ "name": "resourcetype", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", @@ -101905,61 +111562,63 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { @@ -101973,19 +111632,29 @@ "type": "state" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" } ], "since": "4.10.0" @@ -101998,21 +111667,21 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "path to list on image store", "length": 255, - "name": "keyword", + "name": "path", "required": false, "type": "string" }, { - "description": "path to list on image store", + "description": "List by keyword", "length": 255, - "name": "path", + "name": "keyword", "required": false, "type": "string" }, @@ -102027,7 +111696,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -102035,19 +111704,18 @@ "related": "", "response": [ { - "description": "Volume Name associated with the data store object.", - "name": "volumename", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, - {}, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "Volume ID associated with the data store object.", + "name": "volumeid", + "type": "string" }, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, { @@ -102055,16 +111723,10 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", - "type": "string" - }, { - "description": "Template Name associated with the data store object.", - "name": "templatename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Name of the data store object.", @@ -102072,13 +111734,14 @@ "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" }, + {}, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "Template Name associated with the data store object.", + "name": "templatename", "type": "string" }, { @@ -102086,20 +111749,26 @@ "name": "templateid", "type": "string" }, + {}, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" + "description": "Size is in Bytes.", + "name": "size", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", + "type": "string" + }, + { + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" } ], "since": "4.19.0" @@ -102117,6 +111786,14 @@ "required": false, "type": "uuid" }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "account who will own the VLAN", "length": 255, @@ -102138,23 +111815,21 @@ "related": "", "required": true, "type": "uuid" - }, - { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -102162,33 +111837,28 @@ "type": "integer" }, { - "description": "the project name of the guest vlan range", - "name": "project", - "type": "string" + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -102197,20 +111867,19 @@ "type": "string" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" }, - {}, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" } ] }, @@ -102220,16 +111889,9 @@ "name": "updateIso", "params": [ { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "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)", "length": 255, - "name": "isrouting", + "name": "cleanupdetails", "required": false, "type": "boolean" }, @@ -102241,16 +111903,16 @@ "type": "boolean" }, { - "description": "the name of the image file", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "name", + "name": "bootable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "bootable", + "name": "requireshvm", "required": false, "type": "boolean" }, @@ -102263,19 +111925,18 @@ "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this image.", - "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "sort key of the template, integer", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "sortkey", + "name": "isrouting", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "true if the template supports the sshkey upload feature; default is false", @@ -102285,19 +111946,28 @@ "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "sort key of the template, integer", "length": 255, - "name": "passwordenabled", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "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.", "length": 255, - "name": "requireshvm", + "name": "forceupdateostype", "required": false, + "since": "4.21", "type": "boolean" }, + { + "description": "the ID of the OS type that best represents the OS of this image.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, { "description": "the format for the image", "length": 255, @@ -102309,14 +111979,14 @@ "description": "the ID of the image file", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, { - "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)", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "cleanupdetails", + "name": "passwordenabled", "required": false, "type": "boolean" }, @@ -102326,9 +111996,16 @@ "name": "details", "required": false, "type": "map" + }, + { + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", @@ -102336,192 +112013,135 @@ "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, + {}, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "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", - "name": "userdataparams", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, {}, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { @@ -102530,34 +112150,39 @@ "type": "map" }, { - "description": "the project name of the template", - "name": "project", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { "description": "true if this template is a featured template, false otherwise", @@ -102570,14 +112195,14 @@ "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "the name of the zone for this template", @@ -102585,89 +112210,157 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "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", + "name": "userdataparams", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, + {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" } ] }, @@ -102687,8 +112380,8 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -102697,8 +112390,8 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, @@ -102723,9 +112416,9 @@ "type": "string" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", + "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", + "length": 65535, + "name": "csr", "required": false, "type": "string" }, @@ -102737,28 +112430,33 @@ "type": "integer" }, { - "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "domain", + "name": "provider", "required": false, "type": "string" }, { - "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", - "length": 65535, - "name": "csr", + "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", + "length": 255, + "name": "domain", "required": false, "type": "string" } ], "related": "listCaCertificate", "response": [ + { + "description": "The client certificate", + "name": "certificate", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "Private key for the certificate", "name": "privatekey", @@ -102774,11 +112472,6 @@ "name": "jobid", "type": "string" }, - { - "description": "The client certificate", - "name": "certificate", - "type": "string" - }, {} ], "since": "4.11.0" @@ -102789,48 +112482,69 @@ "name": "createPortForwardingRule", "params": [ { - "description": "the ending port of port forwarding rule's private port range", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", "length": 255, - "name": "privateendport", + "name": "openfirewall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", + "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", "length": 255, - "name": "cidrlist", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "VM guest nic secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "type": "string" }, { "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "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", "required": true, "type": "uuid" }, { - "description": "the starting port of port forwarding rule's private port range", + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", "length": 255, - "name": "privateport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "publicendport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "openfirewall", + "name": "privateendport", "required": false, - "type": "boolean" + "type": "integer" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "length": 255, + "name": "publicport", + "required": true, + "type": "integer" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -102841,18 +112555,11 @@ "type": "boolean" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", "length": 255, - "name": "vmguestip", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { "description": "the IP address id of the port forwarding rule", @@ -102861,45 +112568,45 @@ "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" - }, + } + ], + "related": "updatePortForwardingRule", + "response": [ { "description": "the starting port of port forwarding rule's public port range", - "length": 255, "name": "publicport", - "required": true, - "type": "integer" + "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "publicendport", - "required": false, - "type": "integer" - } - ], - "related": "updatePortForwardingRule", - "response": [ - {}, + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the protocol of the port forwarding rule", "name": "protocol", @@ -102909,11 +112616,6 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -102925,23 +112627,28 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -102950,8 +112657,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -102960,47 +112667,48 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, + {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { @@ -103009,28 +112717,13 @@ "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" } ] @@ -103041,19 +112734,19 @@ "name": "prepareTemplate", "params": [ { - "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", + "description": "template ID of the template to be prepared in primary storage(s).", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, + "name": "templateid", + "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, "type": "uuid" }, { - "description": "template ID of the template to be prepared in primary storage(s).", + "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, "type": "uuid" }, { @@ -103065,62 +112758,31 @@ "type": "uuid" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ - {}, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "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", + "name": "userdataparams", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { @@ -103133,13 +112795,18 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -103148,23 +112815,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -103173,32 +112840,32 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the template display text", @@ -103206,175 +112873,175 @@ "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { "description": "the format of the template.", "name": "format", "type": "imageformat" }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, { "description": "the name of the OS type for this template.", "name": "ostypename", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "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", - "name": "userdataparams", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, + {}, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the template name", - "name": "name", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, - {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { "description": "VMware only: additional key/value details tied with deploy-as-is template", @@ -103382,29 +113049,71 @@ "type": "map" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, { "description": "the project id of the template", "name": "projectid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the template ID", + "name": "id", + "type": "string" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -103413,13 +113122,6 @@ "isasync": true, "name": "dedicateZone", "params": [ - { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the ID of the containing domain", "length": 255, @@ -103435,51 +113137,58 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, + { + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" + }, { "description": "the ID of the dedicated resource", "name": "id", "type": "string" }, { - "description": "the Name of the Zone", - "name": "zonename", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, - {}, { "description": "the Account Id to which the Zone is dedicated", "name": "accountid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the Dedication Affinity Group ID of the zone", "name": "affinitygroupid", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the Zone", "name": "zoneid", "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -103495,6 +113204,13 @@ "required": false, "type": "string" }, + { + "description": "The description of the Backup Offering to be updated", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "The ID of the Backup Offering to be updated", "length": 255, @@ -103509,22 +113225,16 @@ "name": "allowuserdrivenbackups", "required": false, "type": "boolean" - }, - { - "description": "The description of the Backup Offering to be updated", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "zone ID", + "name": "zoneid", + "type": "string" }, + {}, { "description": "the date this backup offering was created", "name": "created", @@ -103532,34 +113242,38 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name for the backup offering", + "name": "name", + "type": "string" }, { - "description": "description for the backup offering", - "name": "description", - "type": "string" + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" }, { - "description": "ID of the backup offering", - "name": "id", + "description": "provider name", + "name": "provider", "type": "string" }, { - "description": "zone ID", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the backup offering", + "name": "id", "type": "string" }, - {}, { "description": "external ID on the provider side", "name": "externalid", "type": "string" }, { - "description": "name for the backup offering", - "name": "name", + "description": "description for the backup offering", + "name": "description", "type": "string" }, { @@ -103581,33 +113295,41 @@ "name": "listBuckets", "params": [ { - "description": "the ID of the bucket", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listBuckets", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" + }, + { + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "the IDs of the Buckets, mutually exclusive with id", @@ -103618,34 +113340,33 @@ "type": "list" }, { - "description": "the ID of the object storage pool, available to ROOT admin only", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, - "name": "isrecursive", + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "type": "uuid" }, { "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.", @@ -103655,258 +113376,435 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the bucket", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "id", + "related": "listBuckets", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the project name of the bucket", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, + { + "description": "State of the Bucket", + "name": "state", + "type": "string" + }, + { + "description": "name of the Bucket", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Bucket Secret Key", + "name": "usersecretkey", + "type": "string" + }, + { + "description": "Object storage provider", + "name": "provider", + "type": "string" + }, + { + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + }, + { + "description": "ID of the Bucket", + "name": "id", + "type": "string" + }, + {}, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" + }, + { + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, + { + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" + }, + { + "description": "Bucket URL", + "name": "url", + "type": "string" + }, + { + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" + }, + { + "description": "the project id of the bucket", + "name": "projectid", + "type": "string" + }, + { + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" + }, + { + "description": "the domain associated with the bucket", + "name": "domain", + "type": "string" + }, + { + "description": "the date the Bucket was created", + "name": "created", + "type": "date" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "Stops an Internal LB vm.", + "isasync": true, + "name": "stopInternalLoadBalancerVM", + "params": [ + { + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "Force stop the VM (vm 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 VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the name of the bucket", - "length": 255, + "description": "the name of the router", "name": "name", - "required": false, "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "path of the domain to which the bucket belongs", - "name": "domainpath", + "description": "the id of the router", + "name": "id", "type": "string" }, + {}, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, + {}, { - "description": "Bucket Object Locking", - "name": "objectlocking", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the account associated with the Bucket", - "name": "account", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "Bucket Access Policy", - "name": "policy", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Bucket URL", - "name": "url", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "Object storage provider", - "name": "provider", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the project id of the bucket", - "name": "projectid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "name of the Bucket", - "name": "name", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "Stops an Internal LB vm.", - "isasync": true, - "name": "stopInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "Force stop the VM (vm 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 VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { @@ -103915,162 +113813,152 @@ "type": "date" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, { "description": "the name of the corresponding network", "name": "networkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -104079,23 +113967,28 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], @@ -104106,134 +113999,34 @@ "name": "networkdomain", "type": "string" }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, { "description": "the second DNS for the router", "name": "dns2", "type": "string" }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, { "description": "the domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { @@ -104246,232 +114039,44 @@ "name": "redundantstate", "type": "string" }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - {}, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, { "description": "the host ID for the router", "name": "hostid", "type": "string" }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, { "description": "the public IP address for the router", "name": "publicip", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - } - ] - }, - { - "description": "SP initiated SAML Single Sign On", - "isasync": false, - "name": "samlSso", - "params": [ - { - "description": "Identity Provider Entity ID", - "length": 255, - "name": "idpid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Domain ID that the user belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "last name of the user", - "name": "lastname", - "type": "string" - }, - { - "description": "user time zone", - "name": "timezone", - "type": "string" - }, - {}, - { - "description": "Is two factor authentication verified", - "name": "is2faverified", - "type": "string" - }, - { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", - "type": "string" - }, - { - "description": "Two factor authentication provider", - "name": "providerfor2fa", - "type": "string" - }, - {}, - { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", - "type": "string" - }, - { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", - "type": "string" - }, - { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", - "type": "string" - }, - { - "description": "Username", - "name": "username", - "type": "string" - }, - { - "description": "first name of the user", - "name": "firstname", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" - }, - { - "description": "User ID", - "name": "userid", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" } ] @@ -104508,22 +114113,28 @@ "related": "", "response": [ { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -104531,13 +114142,13 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -104546,23 +114157,23 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -104571,13 +114182,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -104589,93 +114200,164 @@ "type": "set" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, - {}, { - "description": "the project name of the group", - "name": "project", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -104686,8 +114368,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -104696,13 +114378,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -104711,13 +114388,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -104726,8 +114403,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -104737,116 +114419,185 @@ } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, + {} + ], + "since": "4.14.0.0" + }, + { + "description": "Creates a GPU device manually on a host", + "isasync": false, + "name": "createGpuDevice", + "params": [ + { + "description": "Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "ID of the host where the GPU device is located", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "NUMA node of the GPU device (e.g., 0, 1, etc.). This is optional and can be used to specify the NUMA node for the GPU device which is used during allocation. Defaults to -1", + "length": 255, + "name": "numanode", + "required": false, "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "ID of the parent GPU device (for virtual GPU devices)", + "length": 255, + "name": "parentgpudeviceid", + "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the vGPU profile", + "length": 255, + "name": "vgpuprofileid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "ID of the GPU card type", + "length": 255, + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "PCI bus address of the GPU device (e.g., 0000:01:00.0) or UUID for MDEV devices.", + "length": 255, + "name": "busaddress", + "required": true, + "type": "string" + } + ], + "related": "listGpuDevices,discoverGpuDevices", + "response": [ + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, { - "description": "the ID of the security group", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the GPU device", "name": "id", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the host name where the GPU device is attached", + "name": "hostname", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" }, { - "description": "the name of the security group", - "name": "name", + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" + }, + { + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { @@ -104855,23 +114606,47 @@ "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", + "type": "string" + }, + { + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" + }, + { + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" } ], - "since": "4.14.0.0" + "since": "4.21.0" }, { "description": "Creates a domain", "isasync": false, "name": "createDomain", "params": [ + { + "description": "Network domain for networks in the domain", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "creates domain with this name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", "length": 255, @@ -104886,43 +114661,54 @@ "name": "domainid", "required": false, "type": "string" + } + ], + "related": "listDomains,listDomains", + "response": [ + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "Network domain for networks in the domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "creates domain with this name", - "length": 255, - "name": "name", - "required": true, + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" - } - ], - "related": "listDomains,listDomains", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" }, { "description": "the state of the domain", @@ -104930,44 +114716,48 @@ "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the name of the domain", - "name": "name", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, - {}, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the path of the domain", + "name": "path", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { @@ -104976,28 +114766,44 @@ "type": "long" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + {}, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { @@ -105005,40 +114811,54 @@ "name": "projectlimit", "type": "string" }, - {}, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { @@ -105047,18 +114867,33 @@ "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { @@ -105066,105 +114901,106 @@ "name": "hasannotations", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the total number of networks available to be created for this domain", "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, + {}, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" + }, { "description": "the total number of vpcs the domain can own", "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" } ] }, @@ -105173,20 +115009,6 @@ "isasync": false, "name": "addImageStore", "params": [ - { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the URL for the image store", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, { "description": "the Zone ID for the image store", "length": 255, @@ -105208,16 +115030,29 @@ "name": "provider", "required": true, "type": "string" + }, + { + "description": "the URL for the image store", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" } ], "related": "addSecondaryStorage,listSwifts", "response": [ { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, - {}, { "description": "the provider name of the image store", "name": "providername", @@ -105228,15 +115063,17 @@ "name": "disksizeused", "type": "long" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the image store", + "name": "name", "type": "string" }, + {}, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -105244,8 +115081,13 @@ "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -105254,35 +115096,29 @@ "type": "scopetype" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "the name of the image store", - "name": "name", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, - {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.2.0" @@ -105293,12 +115129,11 @@ "name": "revokeTemplateDirectDownloadCertificate", "params": [ { - "description": "id of the certificate", + "description": "(optional) alias of the SSL certificate", "length": 255, - "name": "id", - "related": "listTemplateDirectDownloadCertificates", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "(optional) hypervisor type", @@ -105308,19 +115143,20 @@ "type": "string" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "id of the certificate", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "id", + "related": "listTemplateDirectDownloadCertificates", "required": false, "type": "uuid" }, { - "description": "(optional) alias of the SSL certificate", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "name", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { "description": "(optional) zone to revoke certificate", @@ -105338,32 +115174,32 @@ "name": "jobid", "type": "string" }, + { + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" + }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the host", "name": "hostname", "type": "string" }, + {}, { "description": "the ID of the host", "name": "hostid", "type": "string" }, - { - "description": "indicates the details in case of failure or host skipped", - "name": "details", - "type": "string" - }, - {}, { "description": "indicates if the certificate has been revoked from the host, failed or skipped", "name": "status", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.13" @@ -105385,46 +115221,122 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, + {}, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + {}, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the storage pool path", + "name": "path", + "type": "string" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, - {}, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, { "description": "the date and time the storage pool was created", "name": "created", @@ -105436,29 +115348,43 @@ "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, - {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { @@ -105467,34 +115393,131 @@ "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + } + ], + "since": "4.16.0" + }, + { + "description": "Unregister an extension with a resource", + "isasync": false, + "name": "unregisterExtension", + "params": [ + { + "description": "Type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "ID of the resource to register the extension with", + "length": 255, + "name": "resourceid", + "required": true, "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", + "description": "ID of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions,updateExtension,unregisterExtension", + "required": true, + "type": "uuid" + } + ], + "related": "listExtensions,updateExtension", + "response": [ + {}, + { + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + } + ], + "type": "list" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "The details of the extension", + "name": "details", "type": "map" }, + {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "Name of the extension", + "name": "name", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "Type of the extension", + "name": "type", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The state of the extension", + "name": "state", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -105502,63 +115525,124 @@ "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "Description of the extension", + "name": "description", + "type": "string" + }, + {} + ], + "since": "4.21.0" + }, + { + "description": "list all NSX controllers added to CloudStack", + "isasync": false, + "name": "listNsxControllers", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "NSX controller added to the specific zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "NSX controller port", + "name": "port", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone ID to which the NSX controller is associated with", + "name": "zoneid", + "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", + "type": "string" }, + {}, + {}, { - "description": "the storage pool type", - "name": "type", + "description": "NSX controller name", + "name": "name", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", + "name": "transportzone", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "NSX controller hostname or IP address", + "name": "hostname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", + "name": "edgecluster", + "type": "string" + }, + { + "description": "NSX controller ID", + "name": "nsxprovideruuid", "type": "string" } ], - "since": "4.16.0" + "since": "4.19.0" }, { "description": "Changes ownership of a Volume from one account to another.", "isasync": false, "name": "assignVolume", "params": [ + { + "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" + }, { "description": "The ID of the volume to be reassigned.", "length": 255, @@ -105574,346 +115658,351 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", - "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", - "required": false, - "type": "uuid" } ], "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, { "description": "the boolean state of whether the volume is destroyed or not", "name": "destroyed", "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, - {}, { - "description": "name of the disk volume", - "name": "name", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { "description": "bytes write rate of the disk volume", @@ -105921,38 +116010,33 @@ "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -105961,55 +116045,47 @@ "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - } + {} ], "since": "4.18.0.0" }, @@ -106019,19 +116095,18 @@ "name": "deleteUserData", "params": [ { - "description": "the ID of the Userdata", + "description": "an optional account for the userdata. Must be used with domainId.", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "an optional project for the userdata", + "description": "the ID of the Userdata", "length": 255, - "name": "projectid", + "name": "id", "related": "", - "required": false, + "required": true, "type": "uuid" }, { @@ -106043,35 +116118,36 @@ "type": "uuid" }, { - "description": "an optional account for the userdata. Must be used with domainId.", + "description": "an optional project for the userdata", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.18" @@ -106082,9 +116158,9 @@ "name": "listSupportedNetworkServices", "params": [ { - "description": "List by keyword", + "description": "network service name to list providers and capabilities of", "length": 255, - "name": "keyword", + "name": "service", "required": false, "type": "string" }, @@ -106096,18 +116172,18 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "network service name to list providers and capabilities of", + "description": "", "length": 255, - "name": "service", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -106119,17 +116195,6 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the service name", "name": "name", @@ -106137,27 +116202,45 @@ }, {}, { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the capability value", + "name": "value", + "type": "string" }, { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -106166,35 +116249,28 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", "type": "string" }, { "description": "services for this provider", "name": "servicelist", "type": "list" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the capability name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" } ], @@ -106223,11 +116299,6 @@ "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "true if operation is executed successfully", @@ -106239,6 +116310,11 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -106248,46 +116324,48 @@ "name": "addNetworkServiceProvider", "params": [ { - "description": "the list of services to be enabled for this physical network service provider", + "description": "the name for the physical network service provider", "length": 255, - "name": "servicelist", - "required": false, - "type": "list" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the destination Physical Network ID to bridge to", + "description": "the Physical Network ID to add the provider to", "length": 255, - "name": "destinationphysicalnetworkid", + "name": "physicalnetworkid", "related": "", - "required": false, + "required": true, "type": "uuid" }, { - "description": "the name for the physical network service provider", + "description": "the list of services to be enabled for this physical network service provider", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "servicelist", + "required": false, + "type": "list" }, { - "description": "the Physical Network ID to add the provider to", + "description": "the destination Physical Network ID to bridge to", "length": 255, - "name": "physicalnetworkid", + "name": "destinationphysicalnetworkid", "related": "", - "required": true, + "required": false, "type": "uuid" } ], "related": "listTrafficTypes", "response": [ + {}, + {}, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -106295,16 +116373,9 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, { - "description": "state of the network provider", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -106313,19 +116384,24 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "state of the network provider", + "name": "state", + "type": "string" } ], "since": "3.0.0" @@ -106345,6 +116421,12 @@ } ], "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "any text associated with the success or failure", @@ -106356,16 +116438,10 @@ "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -106384,28 +116460,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.18.0.0" }, @@ -106415,27 +116491,27 @@ "name": "createServiceOffering", "params": [ { - "description": "the ID of the disk offering to which service offering should be mapped", + "description": "the ID of the vGPU profile to which service offering should be mapped", "length": 255, - "name": "diskofferingid", + "name": "vgpuprofileid", "related": "", "required": false, - "since": "4.17", + "since": "4.21", "type": "uuid" }, { - "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", "length": 255, - "name": "deploymentplanner", + "name": "cpuspeed", "required": false, - "type": "string" + "type": "integer" }, { - "description": "length (in seconds) of the burst", + "description": "the host tag for this service offering.", "length": 255, - "name": "bytesreadratemaxlength", + "name": "hosttags", "required": false, - "type": "long" + "type": "string" }, { "description": "the storage type of the service offering. Values are local and shared.", @@ -106445,18 +116521,25 @@ "type": "string" }, { - "description": "burst bytes write rate of the disk offering", + "description": "is this a system vm offering", "length": 255, - "name": "byteswriteratemax", + "name": "issystem", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", + "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", "length": 255, - "name": "purgeresources", + "name": "deploymentplanner", "required": false, - "since": "4.20", + "type": "string" + }, + { + "description": "whether compute offering iops is custom or not", + "length": 255, + "name": "customizediops", + "required": false, + "since": "4.4", "type": "boolean" }, { @@ -106467,94 +116550,113 @@ "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "bytesreadrate", + "name": "storagepolicy", + "related": "", "required": false, - "type": "long" + "since": "4.15", + "type": "uuid" }, { - "description": "is this a system vm offering", + "description": "the tags for this service offering.", "length": 255, - "name": "issystem", + "name": "tags", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name of the service offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "iopsreadrate", + "required": false, + "type": "long" }, { - "description": "VMs using this offering require root volume encryption", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "encryptroot", + "name": "iopswriteratemax", "required": false, - "since": "4.18", - "type": "boolean" + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "provisioningtype", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "since": "4.13", + "type": "list" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "length (in seconds) of the burst", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "iopswriteratemaxlength", "required": false, - "type": "list" + "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "diskofferingstrictness", + "name": "cachemode", "required": false, - "since": "4.17", - "type": "boolean" + "since": "4.14", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "networkrate", + "name": "maxmemory", "required": false, + "since": "4.13", "type": "integer" }, { - "description": "the total memory of the service offering in MB", + "description": "length (in seconds) of the burst", "length": 255, - "name": "memory", + "name": "bytesreadratemaxlength", "required": false, - "type": "integer" + "type": "long" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "maxcpunumber", + "name": "systemvmtype", "required": false, - "since": "4.13", - "type": "integer" + "type": "string" }, { - "description": "the HA for the service offering", + "description": "VMs using this offering require root volume encryption", "length": 255, - "name": "offerha", + "name": "encryptroot", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "Whether service offering size is custom or not", "length": 255, - "name": "mincpunumber", + "name": "customized", + "required": false, + "since": "4.13", + "type": "boolean" + }, + { + "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "length": 255, + "name": "maxcpunumber", "required": false, "since": "4.13", "type": "integer" }, + { + "description": "the Root disk size in GB.", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.15", + "type": "long" + }, { "description": "length (in seconds) of the burst", "length": 255, @@ -106563,51 +116665,49 @@ "type": "long" }, { - "description": "whether compute offering iops is custom or not", + "description": "restrict the CPU usage to committed service offering", "length": 255, - "name": "customizediops", + "name": "limitcpuuse", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "io requests write rate of the disk offering", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "bytesreadrate", "required": false, "type": "long" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "dynamicscalingenabled", "required": false, - "since": "4.13", - "type": "list" + "since": "4.16", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "the HA for the service offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "offerha", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Whether service offering size is custom or not", + "description": "Number of days instance is leased for.", "length": 255, - "name": "customized", + "name": "leaseduration", "required": false, - "since": "4.13", - "type": "boolean" + "since": "4.21.0", + "type": "integer" }, { - "description": "min iops of the compute offering", + "description": "Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.", "length": 255, - "name": "miniops", + "name": "gpucount", "required": false, - "since": "4.4", - "type": "long" + "since": "4.21", + "type": "integer" }, { "description": "burst requests read rate of the disk offering", @@ -106617,123 +116717,133 @@ "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "limitcpuuse", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "length (in seconds) of the burst", + "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", "length": 255, - "name": "iopswriteratemaxlength", + "name": "isvolatile", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "max iops of the compute offering", "length": 255, - "name": "systemvmtype", + "name": "maxiops", "required": false, - "type": "string" + "since": "4.4", + "type": "long" }, { - "description": "the CPU number of the service offering", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "cpunumber", + "name": "minmemory", "required": false, + "since": "4.13", "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "the name of the service offering", "length": 255, - "name": "cachemode", - "required": false, - "since": "4.14", + "name": "name", + "required": true, "type": "string" }, { - "description": "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", "length": 255, - "name": "isvolatile", + "name": "diskofferingstrictness", "required": false, + "since": "4.17", "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "iopswriteratemax", + "name": "provisioningtype", "required": false, - "type": "long" + "type": "string" }, { - "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", + "description": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", "length": 255, - "name": "cpuspeed", + "name": "purgeresources", "required": false, - "type": "integer" + "since": "4.20", + "type": "boolean" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "Whether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "gpudisplay", "required": false, - "since": "4.4", - "type": "integer" + "since": "4.21", + "type": "boolean" }, { - "description": "The maximum memory size of the custom service offering in MB", + "description": "the CPU number of the service offering", "length": 255, - "name": "maxmemory", + "name": "cpunumber", "required": false, - "since": "4.13", "type": "integer" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "storagepolicy", - "related": "", + "name": "iopswriterate", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "the host tag for this service offering.", + "description": "the ID of the disk offering to which service offering should be mapped", "length": 255, - "name": "hosttags", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "since": "4.17", + "type": "uuid" }, { - "description": "The minimum memory size of the custom service offering in MB", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "minmemory", + "name": "bytesreadratemax", "required": false, - "since": "4.13", - "type": "integer" + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "bytesreadratemax", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "the tags for this service offering.", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "tags", + "name": "leaseexpiryaction", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "max iops of the compute offering", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "maxiops", + "name": "hypervisorsnapshotreserve", "required": false, "since": "4.4", - "type": "long" + "type": "integer" + }, + { + "description": "the total memory of the service offering in MB", + "length": 255, + "name": "memory", + "required": false, + "type": "integer" }, { "description": "details for planner, used to store specific parameters", @@ -106743,11 +116853,25 @@ "type": "map" }, { - "description": "the Root disk size in GB.", + "description": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "rootdisksize", + "name": "mincpunumber", + "required": false, + "since": "4.13", + "type": "integer" + }, + { + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopsreadratemaxlength", "required": false, - "since": "4.15", "type": "long" }, { @@ -106758,134 +116882,209 @@ "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "dynamicscalingenabled", + "name": "externaldetails", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.21.0", + "type": "map" }, { - "description": "io requests read rate of the disk offering", + "description": "min iops of the compute offering", "length": 255, - "name": "iopsreadrate", + "name": "miniops", "required": false, + "since": "4.4", "type": "long" } ], "related": "updateServiceOffering,listServiceOfferings", "response": [ { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" }, { - "description": "state of the service offering", - "name": "state", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, + { + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" + }, { "description": "Root disk size in GB", "name": "rootdisksize", "type": "long" }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + {}, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, { "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" + }, + { + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { "description": "the ID of the disk offering to which service offering is linked", "name": "diskofferingid", "type": "string" }, - {}, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", + "type": "boolean" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { "description": "burst io requests write rate of the disk offering", @@ -106893,93 +117092,88 @@ "type": "long" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", - "type": "string" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the name of the service offering", + "name": "name", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { @@ -106988,69 +117182,60 @@ "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, + {}, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", "type": "boolean" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "state of the service offering", + "name": "state", + "type": "string" } ] }, @@ -107068,19 +117253,28 @@ "type": "uuid" }, { - "description": "domain id of the new VM owner.", + "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "type": "list" + }, + { + "description": "id of the VM to be moved", + "length": 255, + "name": "virtualmachineid", + "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", + "required": true, "type": "uuid" }, { - "description": "account name of the new VM owner.", + "description": "domain id of the new VM owner.", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", @@ -107091,42 +117285,133 @@ "type": "list" }, { - "description": "id of the VM to be moved", - "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "description": "account name of the new VM owner.", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "account", "required": false, - "type": "list" + "type": "string" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "related": "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", "response": [ + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -107134,134 +117419,299 @@ "name": "templateid", "type": "string" }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, { "description": "the control state of the host for the virtual machine", "name": "hostcontrolstate", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { "description": "the extra dhcp options on the nic", @@ -107269,23 +117719,23 @@ "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -107294,255 +117744,177 @@ "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, { "description": "CPU arch of the VM", "name": "arch", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { "description": "NICs of the VNF appliance", @@ -107550,123 +117922,54 @@ "type": "list" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - {}, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the availability zone for the virtual machine", @@ -107674,54 +117977,50 @@ "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "true if the entity/resource has annotations", @@ -107729,72 +118028,53 @@ "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -107802,25 +118082,20 @@ "name": "domain", "type": "string" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -107846,28 +118121,28 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -107876,33 +118151,38 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -107912,62 +118192,27 @@ "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -107980,38 +118225,28 @@ "name": "icmptype", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -108020,8 +118255,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -108030,31 +118265,51 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], @@ -108065,33 +118320,33 @@ "name": "domainpath", "type": "string" }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -108105,105 +118360,95 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" } ], "since": "3.0.0" @@ -108213,6 +118458,13 @@ "isasync": false, "name": "listVmsForImport", "params": [ + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, { "description": "the zone ID", "length": 255, @@ -108250,11 +118502,11 @@ "type": "string" }, { - "description": "hypervisor type of the host", + "description": "", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -108262,173 +118514,108 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "listVmwareDcVms,listUnmanagedInstances", "response": [ {}, - { - "description": "the operating system ID of the virtual machine", - "name": "osid", - "type": "string" - }, - { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" - }, { "description": "the CPU cores per socket for the virtual machine. VMware specific", "name": "cpucorepersocket", "type": "integer" }, - {}, - { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", - "type": "string" - }, - { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "type": "string" - }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, - { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, { "description": "the name of the cluster to which virtual machine belongs", "name": "clustername", "type": "string" }, - { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" - }, { "description": "indicates the boot type", "name": "boottype", "type": "string" }, { - "description": "indicates the boot mode", - "name": "bootmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ + }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -108437,38 +118624,33 @@ "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -108477,108 +118659,171 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" - }, + } + ], + "type": "set" + }, + { + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the controller of the disk", + "name": "controller", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorename", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" } ], "type": "set" - } + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" + }, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "indicates the boot mode", + "name": "bootmode", + "type": "string" + }, + {} ], "since": "4.19.0" }, @@ -108595,19 +118840,12 @@ "type": "boolean" }, { - "description": "Netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" - }, - { - "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", "length": 255, - "name": "inline", + "name": "podids", + "related": "createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "list" }, { "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", @@ -108617,12 +118855,19 @@ "type": "long" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", "length": 255, - "name": "podids", - "related": "createManagementNetworkIpRange", + "name": "inline", "required": false, - "type": "list" + "type": "boolean" + }, + { + "description": "Netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" } ], "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", @@ -108632,27 +118877,6 @@ "name": "physicalnetworkid", "type": "string" }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - {}, { "description": "true if NetScaler device is provisioned to be a GSLB service provider", "name": "gslbprovider", @@ -108660,34 +118884,40 @@ }, {}, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" }, { "description": "device state", "name": "lbdevicestate", "type": "string" }, + { + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" + }, { "description": "private IP of the NetScaler representing GSLB site", "name": "gslbproviderprivateip", "type": "string" }, + { + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" + }, + {}, { "description": "true if device is dedicated for an account", "name": "lbdevicededicated", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the provider", + "name": "provider", + "type": "string" }, { "description": "device id of the netscaler load balancer", @@ -108695,8 +118925,8 @@ "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -108705,14 +118935,29 @@ "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -108722,44 +118967,44 @@ "name": "deleteTungstenFabricServiceGroup", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric service group", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "servicegroupuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric service group", + "description": "the ID of zone", "length": 255, - "name": "servicegroupuuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ] }, { @@ -108767,20 +119012,6 @@ "isasync": false, "name": "addObjectStoragePool", "params": [ - { - "description": "the URL for the object store", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "the object store provider name", "length": 255, @@ -108801,56 +119032,83 @@ "name": "tags", "required": false, "type": "string" + }, + { + "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts", + "length": 255, + "name": "size", + "required": false, + "since": "4.21", + "type": "long" + }, + { + "description": "the URL for the object store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the name of the object store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the url of the object store", - "name": "url", - "type": "string" + "description": "the object store currently used size", + "name": "storageused", + "type": "long" }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + { + "description": "the ID of the object store", + "name": "id", + "type": "string" + }, { "description": "the provider name of the object store", "name": "providername", "type": "string" }, { - "description": "the ID of the object store", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "the object store currently used size", - "name": "storageused", + "description": "the allocated size of the object store", + "name": "storageallocated", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the object store", + "name": "name", "type": "string" }, { "description": "the total size of the object store", "name": "storagetotal", "type": "long" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.19.0" @@ -108878,27 +119136,27 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.15.0" @@ -108924,21 +119182,21 @@ "type": "boolean" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "3.0.0" @@ -108970,39 +119228,39 @@ "type": "string" }, { - "description": "parameters for network device", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "networkdeviceparameterlist", + "name": "networkdevicetype", "required": false, - "type": "map" + "type": "string" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "parameters for network device", "length": 255, - "name": "networkdevicetype", + "name": "networkdeviceparameterlist", "required": false, - "type": "string" + "type": "map" } ], "related": "addNetworkDevice", "response": [ + { + "description": "the ID of the network device", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the ID of the network device", - "name": "id", - "type": "string" - }, - {} + } ] }, { @@ -109010,6 +119268,14 @@ "isasync": false, "name": "listProjectRoles", "params": [ + { + "description": "List project role by project role ID.", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" + }, { "description": "List project role by project role name.", "length": 255, @@ -109020,17 +119286,10 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "List project role by project ID.", "length": 255, @@ -109039,60 +119298,59 @@ "required": true, "type": "uuid" }, - { - "description": "List project role by project role ID.", - "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" - } - ], - "related": "updateProjectRole", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the name of the role", - "name": "name", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, - {}, + } + ], + "related": "updateProjectRole", + "response": [ { - "description": "the description of the role", - "name": "description", + "description": "the id of the project", + "name": "projectid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the role", + "name": "name", "type": "string" }, + {}, { "description": "the ID of the role", "name": "id", "type": "string" }, + {}, { "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).", "name": "ispublic", "type": "boolean" + }, + { + "description": "the description of the role", + "name": "description", + "type": "string" } ], "since": "4.15.0" @@ -109114,42 +119372,42 @@ "related": "", "response": [ { - "description": "device id of the controller", - "name": "id", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, - {}, - {}, { - "description": "the url of the controller api", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the physical network to which this controller belongs to", "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "device id of the controller", + "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "the name assigned to the controller", + "name": "name", + "type": "string" + }, + {} ] }, { @@ -109157,20 +119415,6 @@ "isasync": false, "name": "updateTemplate", "params": [ - { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", - "length": 255, - "name": "templatetype", - "required": false, - "type": "string" - }, { "description": "the display text of the image", "length": 4096, @@ -109186,25 +119430,26 @@ "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "indicates that the template can be used for deployment of CKS clusters", "length": 255, - "name": "arch", + "name": "forcks", "required": false, - "since": "4.20", - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "requireshvm", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of the image file", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, @@ -109216,60 +119461,60 @@ "type": "integer" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the tag for this template.", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "templatetag", + "name": "isdynamicallyscalable", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "passwordenabled", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "isrouting", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the format for the image", "length": 255, - "name": "details", + "name": "format", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "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.", "length": 255, - "name": "bootable", + "name": "forceupdateostype", "required": false, + "since": "4.21", "type": "boolean" }, { - "description": "the format for the image", + "description": "the tag for this template.", "length": 255, - "name": "format", + "name": "templatetag", "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "isdynamicallyscalable", + "name": "passwordenabled", "required": false, "type": "boolean" }, @@ -109279,151 +119524,165 @@ "name": "cleanupdetails", "required": false, "type": "boolean" - } - ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "response": [ + }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, "type": "boolean" }, { - "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", - "name": "userdataparams", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "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", + "name": "userdataparams", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -109432,104 +119691,119 @@ "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, + {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, - {}, { - "description": "the template name", - "name": "name", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { @@ -109538,43 +119812,59 @@ "type": "long" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { "description": "true if the template is ready to be deployed from, false otherwise.", "name": "isready", "type": "boolean" }, + {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { @@ -109583,8 +119873,18 @@ "type": "map" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { @@ -109598,29 +119898,19 @@ "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" } ] }, @@ -109630,40 +119920,32 @@ "name": "createVlanIpRange", "params": [ { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, - { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "endipv6", + "name": "netmask", "required": false, "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "netmask", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "vlan", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "projectid", - "related": "", + "name": "endipv6", "required": false, - "type": "uuid" + "type": "string" }, { "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", @@ -109674,41 +119956,50 @@ "type": "uuid" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "true if the IP range is used for NSX resource", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "fornsx", + "name": "ip6gateway", "required": false, - "since": "4.20.0", - "type": "boolean" + "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "startipv6", + "name": "account", "required": false, "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "forvirtualnetwork", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "startip", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "the network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" }, { "description": "the ending IP address in the VLAN IP range", @@ -109718,54 +120009,53 @@ "type": "string" }, { - "description": "the network id", + "description": "true if VLAN is of Virtual type, false if Direct", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the physical network id", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "startipv6", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "Provider name for which the IP range is reserved for", "length": 255, - "name": "account", + "name": "provider", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the gateway of the VLAN IP range", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "gateway", + "name": "startip", "required": false, "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", "length": 255, - "name": "ip6cidr", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "ip6gateway", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "domain ID of the account owning a VLAN", + "description": "the physical network id", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" } @@ -109773,94 +120063,99 @@ "related": "updateVlanIpRange", "response": [ { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + {}, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, - {}, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { @@ -109869,51 +120164,46 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, - {}, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -109949,120 +120239,116 @@ "related": "", "response": [ { - "description": "the domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the owner", + "name": "account", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "the connection ID", - "name": "id", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, - {}, - { - "description": "the public IP address", - "name": "publicip", - "type": "string" - }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "the owner", - "name": "account", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "the project id", - "name": "projectid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "State of vpn connection", @@ -110070,24 +120356,28 @@ "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" }, - {}, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "passive", "type": "boolean" } ], @@ -110098,13 +120388,6 @@ "isasync": false, "name": "listPaloAltoFirewallNetworks", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "palo alto balancer device ID", "length": 255, @@ -110126,28 +120409,20 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -110156,165 +120431,85 @@ "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - {}, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, - {}, { - "description": "the ID of the Network associated with this network", + "description": "the ID of the Network associated with this private gateway", "name": "associatednetworkid", "type": "string" }, - { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, { "description": "availability of the network offering the network is created from", "name": "networkofferingavailability", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { @@ -110322,34 +120517,27 @@ "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ + }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -110363,44 +120551,61 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the capability name", + "name": "name", "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { @@ -110409,133 +120614,203 @@ "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { "description": "the date this network was created", "name": "created", "type": "date" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, { "description": "The Ipv6 routing type of network offering", "name": "ip6routing", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, { "description": "MTU configured on the network VR's public facing interfaces", "name": "publicmtu", "type": "integer" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { @@ -110544,13 +120819,13 @@ "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { @@ -110564,106 +120839,111 @@ "type": "boolean" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "list" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, + {}, { "description": "true if users from subdomains can access the domain level network", "name": "subdomainaccess", "type": "boolean" }, { - "description": "state of the network", - "name": "state", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the type of the network", + "name": "type", "type": "string" }, { "description": "The routes for the network to ease adding route in upstream router", "name": "ip4routes", "type": "set" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + {}, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" } ] }, @@ -110687,12 +120967,12 @@ "name": "path", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -110706,13 +120986,6 @@ "isasync": false, "name": "listManagementServers", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the id of the management server", "length": 255, @@ -110749,14 +121022,22 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", - "name": "serviceip", - "type": "string" + "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" }, { "description": "the version of the java distribution running the management server process", @@ -110764,14 +121045,14 @@ "type": "string" }, { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", + "description": "the last time this Management Server was started", + "name": "lastserverstart", "type": "date" }, { - "description": "the IP Address for this Management Server", - "name": "ipaddress", - "type": "string" + "description": "the agents this Management Server is responsible for", + "name": "agents", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", @@ -110779,60 +121060,79 @@ "type": "integer" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", "type": "date" }, - {}, + { + "description": "the number of pending jobs in this Management Server", + "name": "pendingjobscount", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the management server", - "name": "name", + "description": "the ID of the management server", + "name": "id", "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the Management Server Peers", + "name": "peers", + "type": "list" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", + "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the IP Address for this Management Server", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the Management Server Peers", - "name": "peers", - "type": "list" + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" }, + { + "description": "the number of host agents this Management Server is responsible for", + "name": "agentscount", + "type": "long" + }, + {}, { "description": "the version of the management server", "name": "version", "type": "string" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" } ] @@ -110843,95 +121143,74 @@ "name": "listTungstenFabricPolicyRule", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "name": "policyuuid", + "required": true, + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric rule", + "description": "", "length": 255, - "name": "ruleuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "", "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric rule", "length": 255, - "name": "keyword", + "name": "ruleuuid", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addTungstenFabricPolicyRule", "response": [ - { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", - "type": "string" - }, { "description": "Tungsten-Fabric policy source network", "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", "type": "int" }, - { - "description": "Tungsten-Fabric policy name", - "name": "direction", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", - "type": "string" - }, - { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", - "type": "string" - }, - {}, { "description": "Tungsten-Fabric policy source ip prefix length", "name": "srcipprefixlen", "type": "int" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { @@ -110940,50 +121219,71 @@ "type": "int" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" + }, + { + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, {}, + { + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", "type": "int" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy action", + "name": "action", + "type": "string" } ] }, @@ -110992,13 +121292,6 @@ "isasync": true, "name": "deleteTungstenFabricPolicy", "params": [ - { - "description": "the Uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -111006,18 +121299,21 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the Uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", @@ -111026,11 +121322,15 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -111056,50 +121356,15 @@ ], "related": "", "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the instance group", - "name": "name", - "type": "string" - }, { "description": "the account owning the instance group", "name": "account", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the instance group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { @@ -111108,151 +121373,64 @@ "type": "date" }, { - "description": "the domain ID of the instance group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the instance group", - "name": "id", - "type": "string" - }, - {} - ] - }, - { - "description": "List the uploaded certificates for direct download templates", - "isasync": false, - "name": "listTemplateDirectDownloadCertificates", - "params": [ - { - "description": "list direct download certificate by ID", - "length": 255, - "name": "id", - "related": "listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" - }, - { - "description": "the zone where certificates are uploaded", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "if set to true: include the hosts where the certificate is uploaded to", - "length": 255, - "name": "listhosts", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "issuer", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" - }, - { - "description": "the direct download certificate alias", - "name": "alias", - "type": "string" - }, - { - "description": "the direct download certificate serial num", - "name": "serialnum", - "type": "string" - }, - { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", - "type": "string" - }, - { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "List ucs manager", + "description": "List the uploaded certificates for direct download templates", "isasync": false, - "name": "listUcsManagers", + "name": "listTemplateDirectDownloadCertificates", "params": [ { - "description": "", + "description": "if set to true: include the hosts where the certificate is uploaded to", "length": 255, - "name": "pagesize", + "name": "listhosts", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "List by keyword", @@ -111262,15 +121440,22 @@ "type": "string" }, { - "description": "the ID of the ucs manager", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list direct download certificate by ID", "length": 255, "name": "id", - "related": "listUcsManagers", + "related": "listTemplateDirectDownloadCertificates", "required": false, "type": "uuid" }, { - "description": "the zone id", + "description": "the zone where certificates are uploaded", "length": 255, "name": "zoneid", "related": "listZones", @@ -111280,248 +121465,238 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ - { - "description": "the ID of the ucs manager", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the zone ID of ucs manager", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the url of ucs manager", - "name": "url", - "type": "string" - }, - { - "description": "the name of ucs manager", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Upgrades domain router to a new service offering", - "isasync": false, - "name": "changeServiceForRouter", - "params": [ - { - "description": "The ID of the router", - "length": 255, - "name": "id", - "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" - }, - { - "description": "the service offering ID to apply to the domain router", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - } - ], - "related": "listRouters,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { - "description": "the version of template", + "description": "the direct download certificate version", "name": "version", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the direct download certificate serial num", + "name": "serialnum", + "type": "string" }, + {}, + {} + ], + "since": "4.17.0" + }, + { + "description": "List ucs manager", + "isasync": false, + "name": "listUcsManagers", + "params": [ { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the id of the router", + "description": "the ID of the ucs manager", + "length": 255, "name": "id", - "type": "string" + "related": "listUcsManagers", + "required": false, + "type": "uuid" }, { - "description": "the Zone ID for the router", + "description": "the zone id", + "length": 255, "name": "zoneid", - "type": "string" - }, + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the project name of the address", - "name": "project", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the router", + "description": "the name of ucs manager", "name": "name", "type": "string" }, + {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the ucs manager", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" }, + {} + ] + }, + { + "description": "Upgrades domain router to a new service offering", + "isasync": false, + "name": "changeServiceForRouter", + "params": [ { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "The ID of the router", + "length": 255, + "name": "id", + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, + "description": "the service offering ID to apply to the domain router", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,listInternalLoadBalancerVMs", + "response": [ { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the id of the router", + "name": "id", + "type": "string" }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -111535,38 +121710,43 @@ "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -111575,189 +121755,314 @@ "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the ID of the nic", + "name": "id", + "type": "string" } ], "type": "set" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, {}, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, { "description": "the version of scripts", "name": "scriptsversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + {}, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, { "description": "the name of the corresponding guest network", "name": "guestnetworkname", "type": "string" }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, { "description": "the gateway for the router", "name": "gateway", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, - {}, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { "description": "Last executed health check result for the router", "name": "healthcheckresults", "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, { "description": "result of the health check", "name": "success", @@ -111769,51 +122074,46 @@ "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" }, { "description": "the name of the health check on the router", "name": "checkname", "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" } ], "type": "list" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" } ] @@ -111824,18 +122124,11 @@ "name": "updateVolume", "params": [ { - "description": "Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", - "length": 255, - "name": "deleteprotection", - "required": false, - "since": "4.20.0", - "type": "boolean" - }, - { - "description": "The path of the volume", + "description": "The state of the volume", "length": 255, - "name": "path", + "name": "state", "required": false, + "since": "4.3", "type": "string" }, { @@ -111847,13 +122140,20 @@ "type": "string" }, { - "description": "Destination storage pool UUID for the volume", + "description": "Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "deleteprotection", "required": false, - "since": "4.3", - "type": "uuid" + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "The chain info of the volume", + "length": 255, + "name": "chaininfo", + "required": false, + "since": "4.4", + "type": "string" }, { "description": "new name of the volume", @@ -111864,11 +122164,13 @@ "type": "string" }, { - "description": "an optional field, whether to the display the volume to the end user or not.", + "description": "Destination storage pool UUID for the volume", "length": 255, - "name": "displayvolume", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "boolean" + "since": "4.3", + "type": "uuid" }, { "description": "the ID of the disk volume", @@ -111879,28 +122181,26 @@ "type": "uuid" }, { - "description": "The state of the volume", + "description": "an optional field, whether to the display the volume to the end user or not.", "length": 255, - "name": "state", + "name": "displayvolume", "required": false, - "since": "4.3", - "type": "string" + "type": "boolean" }, { - "description": "The chain info of the volume", + "description": "The path of the volume", "length": 255, - "name": "chaininfo", + "name": "path", "required": false, - "since": "4.4", "type": "string" } ], "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { "description": "an optional field whether to the display the volume to the end user or not.", @@ -111908,13 +122208,28 @@ "type": "boolean" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -111923,49 +122238,34 @@ "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { "description": "the VM's disk write in KiB", @@ -111973,84 +122273,94 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "the domain associated with the disk volume", @@ -112058,23 +122368,18 @@ "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { @@ -112083,99 +122388,171 @@ "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, - {}, { - "description": "ID of the disk volume", - "name": "id", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, + {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112184,18 +122561,13 @@ "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { @@ -112203,26 +122575,20 @@ "name": "deleteprotection", "type": "boolean" }, - {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { "description": "cluster id of the volume", @@ -112230,96 +122596,30 @@ "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, + {}, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -112328,14 +122628,6 @@ "isasync": false, "name": "listTrafficTypes", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "", "length": 255, @@ -112356,56 +122648,64 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the provider name", - "name": "name", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "state of the network provider", + "name": "state", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the provider name", + "name": "name", + "type": "string" } ], "since": "3.0.0" @@ -112415,20 +122715,6 @@ "isasync": false, "name": "updateAccount", "params": [ - { - "description": "Current account name", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" - }, { "description": "Details for the account used to store specific parameters", "length": 255, @@ -112452,6 +122738,21 @@ "required": false, "type": "uuid" }, + { + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the domain level setting api.key.access", + "length": 255, + "name": "apikeyaccess", + "required": false, + "since": "4.20.1.0", + "type": "string" + }, { "description": "New name for the account", "length": 255, @@ -112460,52 +122761,46 @@ "type": "string" }, { - "description": "Account UUID", + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the domain level setting api.key.access", + "description": "Account UUID", "length": 255, - "name": "apikeyaccess", + "name": "id", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "required": false, - "since": "4.20.1.0", - "type": "string" + "type": "uuid" } ], "related": "disableAccount,enableAccount,listAccounts", "response": [ { - "description": "the id of the account", - "name": "id", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -112514,68 +122809,221 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { @@ -112584,9 +123032,9 @@ "type": "long" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { "description": "the total number of public ip addresses allocated for this account", @@ -112599,38 +123047,43 @@ "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { @@ -112639,48 +123092,58 @@ "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", "type": "string" }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, { "description": "the total volume available for this account", "name": "volumeavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { @@ -112694,267 +123157,93 @@ "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the total memory (in MB) available to be created for this account", "name": "memoryavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, - {}, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, - {}, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - } - ], - "type": "list" - } - ] - }, - { - "description": "Adds secondary storage.", - "isasync": false, - "name": "addSecondaryStorage", - "params": [ - { - "description": "the Zone ID for the secondary storage", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "the URL for the secondary storage", - "length": 255, - "name": "url", - "required": true, - "type": "string" - } - ], - "related": "listSwifts", - "response": [ + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, { - "description": "the ID of the image store", - "name": "id", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { @@ -112963,486 +123252,360 @@ "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, - {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" - }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" } ] }, { - "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "description": "Adds secondary storage.", "isasync": false, - "name": "updateVirtualMachine", + "name": "addSecondaryStorage", "params": [ { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", - "length": 255, - "name": "name", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18", - "type": "uuid" - }, - { - "description": "The ID of the virtual machine", + "description": "the URL for the secondary storage", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,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,importVm", + "name": "url", "required": true, - "type": "uuid" - }, - { - "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)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - }, - { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the OS type that best represents this VM.", - "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": false, - "type": "uuid" - }, - { - "description": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", - "length": 255, - "name": "deleteprotection", - "required": false, - "since": "4.20.0", - "type": "boolean" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "list of security group ids to be applied on the virtual machine.", - "length": 255, - "name": "securitygroupids", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "group of the virtual machine", - "length": 255, - "name": "group", - "required": false, - "type": "string" - }, - { - "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", - "length": 255, - "name": "dhcpoptionsnetworklist", - "required": false, - "type": "map" - }, - { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, - "type": "boolean" - }, - { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", - "type": "map" - }, - { - "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", - "type": "string" - }, - { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", - "type": "string" - }, - { - "description": "user generated name", - "length": 255, - "name": "displayname", - "required": false, - "type": "string" - }, - { - "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", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.16.0", "type": "string" }, { - "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", - "length": 255, - "name": "securitygroupnames", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "description": "the Zone ID for the secondary storage", "length": 255, - "name": "details", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "map" + "type": "uuid" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "listSwifts", "response": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, + {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "isasync": false, + "name": "updateVirtualMachine", + "params": [ + { + "description": "Number of days to lease the instance from now onward. Use -1 to remove the existing lease", + "length": 255, + "name": "leaseduration", + "required": false, + "since": "4.21.0", + "type": "integer" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "list of security group ids to be applied on the virtual machine.", + "length": 255, + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, - {}, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "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)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "group of the virtual machine", + "length": 255, + "name": "group", + "required": false, "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "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", + "required": true, + "type": "uuid" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "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", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the ID of the OS type that best represents this VM.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "length": 255, + "name": "name", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "length": 255, + "name": "deleteprotection", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "required": false, + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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", + "length": 255, + "name": "securitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "user generated name", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "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", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.16.0", + "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Lease expiry action, valid values are STOP and DESTROY", + "length": 255, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "instance name of the user vm", + "length": 255, + "name": "instancename", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "true if high-availability is enabled for the virtual machine, false otherwise", + "length": 255, + "name": "haenable", + "required": false, + "type": "boolean" + }, + { + "description": "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + } + ], + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { @@ -113451,249 +123614,70 @@ "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, - {}, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -113704,61 +123688,91 @@ "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -113767,18 +123781,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -113787,155 +123801,53 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -113943,34 +123855,24 @@ "name": "protocol", "type": "string" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -113983,23 +123885,23 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -114008,127 +123910,595 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + {}, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" } ], "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, + {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { @@ -114137,87 +124507,107 @@ "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -114226,13 +124616,18 @@ "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -114241,42 +124636,98 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" + }, + {}, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" } ] }, @@ -114286,12 +124737,11 @@ "name": "disableAccount", "params": [ { - "description": "Disables specified account in this domain.", + "description": "If true, only lock the account; else disable the account", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", - "required": false, - "type": "uuid" + "name": "lock", + "required": true, + "type": "boolean" }, { "description": "Disables specified account.", @@ -114309,142 +124759,204 @@ "type": "uuid" }, { - "description": "If true, only lock the account; else disable the account", + "description": "Disables specified account in this domain.", "length": 255, - "name": "lock", - "required": true, - "type": "boolean" + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" } ], "related": "enableAccount,listAccounts", "response": [ { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + {}, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user ID", - "name": "id", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user email address", - "name": "email", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { @@ -114453,167 +124965,166 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" } ], "type": "list" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, { "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", "name": "apikeyaccess", "type": "apikeyaccess" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, - {}, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the state of the account", + "name": "state", + "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the account", + "name": "name", "type": "string" }, { @@ -114622,33 +125133,38 @@ "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -114657,109 +125173,119 @@ "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the id of the account", - "name": "id", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, - {}, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" } ] @@ -114769,6 +125295,22 @@ "isasync": false, "name": "listDomains", "params": [ + { + "description": "Tag for resource type to return usage", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "List domain by domain ID.", + "length": 255, + "name": "id", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, { "description": "flag to display the resource icon for domains", "length": 255, @@ -114783,26 +125325,19 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "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", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "List domain by domain name.", @@ -114812,12 +125347,11 @@ "type": "string" }, { - "description": "List domain by domain ID.", + "description": "", "length": 255, - "name": "id", - "related": "listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", @@ -114827,132 +125361,168 @@ "type": "list" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Tag for resource type to return usage", + "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", "length": 255, - "name": "tag", + "name": "listall", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" } ], "related": "listDomains", "response": [ { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, { "description": "the total number of templates which have been created by this domain", "name": "templatetotal", "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", - "type": "string" + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { @@ -114961,13 +125531,13 @@ "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { @@ -114976,28 +125546,49 @@ "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + {}, { "description": "the path of the domain", "name": "path", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { @@ -115006,104 +125597,114 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, - {}, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" }, + {}, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain", - "name": "id", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" } ] @@ -115122,166 +125723,166 @@ "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", + "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", + "length": 1048576, + "name": "userdata", "required": false, - "type": "map" + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "the ID of the userdata", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "userdataid", + "related": "", "required": false, "type": "uuid" }, - { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,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", "required": true, "type": "uuid" }, { - "description": "the ID of the userdata", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "userdataid", - "related": "", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "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", - "length": 1048576, - "name": "userdata", + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", "required": false, - "type": "string" + "type": "map" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -115289,69 +125890,233 @@ "name": "isoid", "type": "string" }, + {}, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + } + ], + "type": "set" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, + {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -115359,95 +126124,43 @@ "name": "securitygroup", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" }, { "description": "the code for the ICMP message response", @@ -115459,8 +126172,13 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -115469,8 +126187,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -115484,8 +126207,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -115494,105 +126217,50 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, { "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -115603,58 +126271,58 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" } ], @@ -115666,15 +126334,35 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", @@ -115683,412 +126371,384 @@ ], "type": "set" }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, { "description": "the name of the security group", "name": "name", "type": "string" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { "description": "device type of the root volume", @@ -116096,163 +126756,134 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + {}, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, - {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, - {}, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -116261,9 +126892,39 @@ "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" } ], "since": "4.18.0" @@ -116274,12 +126935,12 @@ "name": "deleteTemplate", "params": [ { - "description": "Necessary if the template's type is system.", + "description": "the ID of the template", "length": 255, - "name": "issystem", - "required": false, - "since": "4.20.0", - "type": "boolean" + "name": "id", + "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { "description": "the ID of zone of the template", @@ -116290,44 +126951,44 @@ "type": "uuid" }, { - "description": "Force delete a template.", + "description": "Necessary if the template's type is system.", "length": 255, - "name": "forced", + "name": "issystem", "required": false, - "since": "4.9+", + "since": "4.20.0", "type": "boolean" }, { - "description": "the ID of the template", + "description": "Force delete a template.", "length": 255, - "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", - "required": true, - "type": "uuid" + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" } ], "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -116337,41 +126998,34 @@ "name": "listNetworkACLLists", "params": [ { - "description": "", + "description": "Lists network ACL with the specified ID.", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "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.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listall", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "list network ACLs by VPC ID", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "list network ACLs by specified name", @@ -116381,19 +127035,19 @@ "type": "string" }, { - "description": "Lists network ACL with the specified ID.", + "description": "", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list network ACLs by network ID", @@ -116404,61 +127058,63 @@ "type": "uuid" }, { - "description": "", + "description": "list network ACLs by VPC ID", "length": 255, - "name": "page", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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.", + "length": 255, + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" } ], "related": "createNetworkACLList", "response": [ - { - "description": "the ID of the ACL", - "name": "id", - "type": "string" - }, { "description": "Id of the VPC this ACL is associated with", "name": "vpcid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "Description of the ACL", + "name": "description", "type": "string" }, { - "description": "the Name of the ACL", - "name": "name", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, { @@ -116466,18 +127122,23 @@ "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "Description of the ACL", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Name of the ACL", + "name": "name", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -116496,19 +127157,63 @@ ], "related": "copySnapshot,listSnapshots", "response": [ - {}, + { + "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", + "name": "state", + "type": "state" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -116527,8 +127232,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -116537,18 +127247,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -116560,33 +127270,34 @@ "type": "set" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "ID of the snapshot", + "name": "id", + "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", "type": "long" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, + {}, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { @@ -116595,94 +127306,64 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "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", - "name": "state", - "type": "state" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, + {}, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, - {}, { "description": "type of the datastore for the snapshot entry", "name": "datastoretype", "type": "string" }, - { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, { "description": "ID of the disk volume", "name": "volumeid", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { @@ -116691,38 +127372,23 @@ "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, - { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "volumename", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" } ] @@ -116732,14 +127398,6 @@ "isasync": true, "name": "updateVpnGateway", "params": [ - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "id of customer gateway", "length": 255, @@ -116748,6 +127406,14 @@ "required": true, "type": "uuid" }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -116759,12 +127425,22 @@ ], "related": "", "response": [ + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, + {}, + { + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, - {}, { "description": "the vpc name of this gateway", "name": "vpcname", @@ -116775,25 +127451,25 @@ "name": "account", "type": "string" }, + {}, { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the public IP address", + "name": "publicip", "type": "string" }, - {}, { - "description": "the project id", - "name": "projectid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { @@ -116802,34 +127478,24 @@ "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain name of the owner", + "name": "domain", "type": "string" - }, - { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.4" @@ -116849,15 +127515,85 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Deletes security group", + "isasync": false, + "name": "deleteSecurityGroup", + "params": [ + { + "description": "the project of the security group", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID of account owning the security group", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the account of the security group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The ID of the security group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the security group. Mutually exclusive with id parameter", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { @@ -116865,82 +127601,158 @@ "name": "success", "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Deletes security group", + "description": "Creates a customized GUI theme for a set of Common Names (fixed or wildcard), a set of domain UUIDs, and/or a set of account UUIDs.", "isasync": false, - "name": "deleteSecurityGroup", + "name": "createGuiTheme", "params": [ { - "description": "The ID of the security group. Mutually exclusive with name parameter", - "length": 255, - "name": "id", - "related": "", + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "domainids", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the account of the security group. Must be specified with domain ID", + "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`.", "length": 255, - "name": "account", + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "css", "required": false, "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with id parameter", - "length": 255, - "name": "name", + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "length": 65535, + "name": "accountids", "required": false, "type": "string" }, { - "description": "the domain ID of account owning the security group", - "length": 255, - "name": "domainid", - "related": "listDomains", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "length": 65535, + "name": "commonnames", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the project of the security group", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "length": 65535, + "name": "jsonconfiguration", + "required": false, + "type": "string" + }, + { + "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", "length": 255, - "name": "projectid", - "related": "", + "name": "recursivedomains", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "description": "A description for the theme.", + "length": 4096, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "A name to identify the theme.", + "length": 2048, + "name": "name", + "required": true, + "type": "string" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "name": "commonnames", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Name of the GUI theme.", + "name": "name", + "type": "string" + }, + { + "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`.", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "ID of the custom GUI theme.", + "name": "id", + "type": "string" + }, + { + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", "type": "boolean" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "domainids", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", + "type": "string" + }, + { + "description": "Description of the GUI theme.", + "name": "description", + "type": "string" + }, + { + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", + "type": "string" + }, + { + "description": "A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "name": "accountids", + "type": "string" + }, + { + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} - ] + ], + "since": "4.21.0.0" }, { "description": "Import an unmanaged volume from a storage pool on a host into CloudStack", @@ -116948,17 +127760,17 @@ "name": "importVolume", "params": [ { - "description": "the name of the volume. If not set, it will be set to the path of the volume.", + "description": "the path of the volume", "length": 255, - "name": "name", - "required": false, + "name": "path", + "required": true, "type": "string" }, { - "description": "import volume to the domain specified", + "description": "import volume for the project", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -116970,6 +127782,13 @@ "required": false, "type": "uuid" }, + { + "description": "the name of the volume. If not set, it will be set to the path of the volume.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the ID of the storage pool", "length": 255, @@ -116979,17 +127798,10 @@ "type": "uuid" }, { - "description": "the path of the volume", - "length": 255, - "name": "path", - "required": true, - "type": "string" - }, - { - "description": "import volume for the project", + "description": "import volume to the domain specified", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -117003,11 +127815,10 @@ ], "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { "description": "min iops of the disk volume", @@ -117015,277 +127826,298 @@ "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the status of the volume", - "name": "status", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, - {}, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, + {}, { "description": "state of the virtual machine", "name": "vmstate", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { "description": "the bytes allocated", @@ -117293,18 +128125,18 @@ "type": "long" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -117313,23 +128145,18 @@ "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { @@ -117338,93 +128165,78 @@ "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" } ], @@ -117436,38 +128248,41 @@ "name": "createTemplate", "params": [ { - "description": "the ID of the OS Type that best represents the OS of this template.", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64. Defaults to x86_64", "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": true, - "type": "uuid" + "name": "arch", + "required": false, + "since": "4.20.2", + "type": "string" }, { - "description": "the tag for this template.", + "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", "length": 255, - "name": "templatetag", + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isdynamicallyscalable", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "uuid" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "32 or 64 bit", "length": 255, - "name": "isfeatured", + "name": "bits", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "passwordenabled", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, @@ -117479,87 +128294,93 @@ "type": "string" }, { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "snapshotid", - "related": "copySnapshot,listSnapshots", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the name of the template", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "description": "the zone for the template. Can be specified with snapshot only", "length": 255, - "name": "volumeid", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.19.0", "type": "uuid" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "true if the template requires HVM, false otherwise", "length": 255, - "name": "details", + "name": "requireshvm", "required": false, - "type": "map" + "type": "boolean" }, { "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,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", "required": false, "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "requireshvm", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the name of the template", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "32 or 64 bit", + "description": "the tag for this template.", "length": 255, - "name": "bits", + "name": "templatetag", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "isfeatured", "required": false, - "since": "4.19.0", - "type": "uuid" + "type": "boolean" }, { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the zone for the template. Can be specified with snapshot only", + "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "ostypeid", + "related": "addGuestOs", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "length": 255, + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "since": "4.19.0", "type": "uuid" }, { @@ -117571,27 +128392,27 @@ "type": "uuid" }, { - "description": "true if this template is a public template, false otherwise", - "length": 255, - "name": "ispublic", + "description": "The display text of the template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "account", + "name": "sshkeyenabled", "required": false, - "since": "4.19.0", - "type": "string" + "type": "boolean" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ + {}, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "true if this template is a public template, false otherwise", @@ -117599,13 +128420,28 @@ "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -117614,131 +128450,84 @@ "type": "set" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, { "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "the template display text", @@ -117746,90 +128535,90 @@ "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, - {}, - {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the date this template was removed", "name": "removed", "type": "date" }, + {}, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "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", + "name": "userdataparams", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -117838,79 +128627,126 @@ "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "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", - "name": "userdataparams", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { "description": "the project name of the template", @@ -117918,14 +128754,14 @@ "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" } ] }, @@ -117944,28 +128780,28 @@ } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "4.14.0" }, @@ -117989,10 +128825,10 @@ "type": "string" }, { - "description": "A name / alias for the certificate.", + "description": "DNS domain suffix that the certificate is granted for.", "length": 255, - "name": "name", - "required": false, + "name": "domainsuffix", + "required": true, "type": "string" }, { @@ -118003,31 +128839,31 @@ "type": "string" }, { - "description": "DNS domain suffix that the certificate is granted for.", + "description": "A name / alias for the certificate.", "length": 255, - "name": "domainsuffix", - "required": true, + "name": "name", + "required": false, "type": "string" } ], "related": "", "response": [ {}, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "message of the certificate upload operation", "name": "message", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -118036,14 +128872,6 @@ "isasync": false, "name": "listDedicatedClusters", "params": [ - { - "description": "the ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, { "description": "the ID of the domain associated with the cluster", "length": 255, @@ -118053,24 +128881,31 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the account associated with the cluster. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "list dedicated clusters by affinity group", + "description": "the ID of the cluster", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -118082,55 +128917,56 @@ "type": "integer" }, { - "description": "", + "description": "list dedicated clusters by affinity group", "length": 255, - "name": "pagesize", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" }, - {}, { "description": "the ID of the cluster", "name": "clusterid", "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the name of the cluster", "name": "clustername", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" } ] @@ -118142,11 +128978,6 @@ "params": [], "related": "", "response": [ - { - "description": "timestamp when the run got over", - "name": "updated_on", - "type": "date" - }, {}, {}, { @@ -118154,6 +128985,11 @@ "name": "jobid", "type": "string" }, + { + "description": "timestamp when the run got over", + "name": "updated_on", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -118167,6 +129003,28 @@ "isasync": false, "name": "listTungstenFabricNetwork", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "the uuid of Tungsten-Fabric network", "length": 255, @@ -118174,13 +129032,62 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false", "length": 255, "name": "listall", "required": false, "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric network uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric network name", + "name": "name", + "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "List traffic monitor Hosts.", + "isasync": false, + "name": "listTrafficMonitors", + "params": [ { "description": "", "length": 255, @@ -118188,39 +129095,269 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "zone Id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, "name": "keyword", "required": false, "type": "string" + } + ], + "related": "addTrafficMonitor", + "response": [ + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" }, { - "description": "", + "description": "the ID of the external firewall", + "name": "id", + "type": "string" + }, + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" + } + ] + }, + { + "description": "Releases an existing dedicated Bgp Peer.", + "isasync": true, + "name": "releaseBgpPeer", + "params": [ + { + "description": "Id of the Bgp Peer", "length": 255, - "name": "page", + "name": "id", + "related": "releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" + }, + { + "description": "password of bgp peer", + "name": "password", + "type": "string" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "isasync": true, + "name": "updatePortForwardingRule", + "params": [ + { + "description": "the ID of the virtual machine for the port forwarding rule", + "length": 255, + "name": "virtualmachineid", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,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", + "required": false, + "type": "uuid" + }, + { + "description": "the private end port of the port forwarding rule", + "length": 255, + "name": "privateendport", "required": false, "type": "integer" }, { - "description": "the ID of zone", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the private start port of the port forwarding rule", + "length": 255, + "name": "privateport", + "required": false, + "type": "integer" + }, + { + "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "VM guest nic Secondary ip address for the port forwarding rule", + "length": 255, + "name": "vmguestip", "required": false, + "since": "4.5", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updatePortForwardingRule", + "required": true, + "since": "4.4", "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "Tungsten-Fabric network name", - "name": "name", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { @@ -118229,243 +129366,660 @@ "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" }, {}, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric network uuid", - "name": "uuid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" - } + }, + {} ] }, { - "description": "List traffic monitor Hosts.", - "isasync": false, - "name": "listTrafficMonitors", + "description": "Acquires and associates a public IP to an account.", + "isasync": true, + "name": "associateIpAddress", "params": [ { - "description": "zone Id", + "description": "the VPC you want the IP address to be associated with", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, "type": "uuid" }, { - "description": "", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "List by keyword", + "description": "The network this IP address should be associated to.", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "IP Address to be associated", + "length": 255, + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "", + "description": "region ID from where portable IP is to be associated.", "length": 255, - "name": "page", + "name": "regionid", + "related": "", "required": false, "type": "integer" + }, + { + "description": "Deploy VM for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the account to associate with this IP address", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the domain to associate with this IP address", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "length": 255, + "name": "isportable", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the availability zone you want to acquire an public IP address from", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], - "related": "addTrafficMonitor", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, - {}, { - "description": "the ID of the external firewall", - "name": "id", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, - {}, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "public IP address id", + "name": "id", + "type": "string" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the management IP address of the external firewall", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, + {}, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address", "name": "ipaddress", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + { + "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", + "name": "purpose", + "type": "string" + }, + { + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" } ] }, { - "description": "Releases an existing dedicated Bgp Peer.", - "isasync": true, - "name": "releaseBgpPeer", + "description": "Get the SF Volume Access Group IDs", + "isasync": false, + "name": "getSolidFireVolumeAccessGroupIds", "params": [ { - "description": "Id of the Bgp Peer", + "description": "Cluster UUID", "length": 255, - "name": "id", - "related": "releaseBgpPeer", + "name": "clusterid", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, + "type": "string" } ], "related": "", "response": [ + {}, + {}, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Delete site to site vpn connection", + "isasync": true, + "name": "deleteVpnConnection", + "params": [ + { + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "Lists all alerts types", + "isasync": false, + "name": "listAlertTypes", + "params": [], + "related": "listAlerts", + "response": [ { - "description": "date when this bgp peer was created.", - "name": "created", + "description": "the date and time the alert was sent", + "name": "sent", "type": "date" }, - { - "description": "the project id of the bgp peer", - "name": "projectid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" - }, - { - "description": "the account of the bgp peer", - "name": "account", - "type": "string" - }, - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "description of the alert", + "name": "description", "type": "string" }, + {}, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the name of the alert", + "name": "name", "type": "string" }, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, {}, { - "description": "password of bgp peer", - "name": "password", - "type": "string" - }, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the id of the alert", + "name": "id", "type": "string" } - ], - "since": "4.20.0" + ] }, { - "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", "isasync": true, - "name": "updatePortForwardingRule", + "name": "createNetworkACL", "params": [ { - "description": "the private start port of the port forwarding rule", + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "privateport", + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the private end port of the port forwarding rule", + "description": "type of the ICMP message being sent", "length": 255, - "name": "privateendport", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "customid", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "the ID of the port forwarding rule", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "id", - "related": "updatePortForwardingRule", - "required": true, - "since": "4.4", + "name": "aclid", + "related": "createNetworkACLList", + "required": false, "type": "uuid" }, { - "description": " the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "cidrlist", + "name": "reason", "required": false, - "type": "list" + "type": "string" + }, + { + "description": "The number of the ACL item, its ordering", + "length": 255, + "name": "number", + "required": false, + "type": "integer" + }, + { + "description": "the starting port of ACL", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -118476,67 +130030,100 @@ "type": "boolean" }, { - "description": "VM guest nic Secondary ip address for the port forwarding rule", + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "vmguestip", + "name": "traffictype", "required": false, - "since": "4.5", "type": "string" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "the ending port of ACL", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, + "type": "string" } ], - "related": "", + "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ - {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, + {}, + {}, { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -118545,33 +130132,33 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -118580,912 +130167,626 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" } ] }, { - "description": "Acquires and associates a public IP to an account.", + "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", "isasync": true, - "name": "associateIpAddress", + "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "IP Address to be associated", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "Deploy VM for the project", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "The network this IP address should be associated to.", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "fordisplay", + "name": "keypairs", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.17", + "type": "list" }, { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "description": "The ID of the virtual machine", "length": 255, - "name": "isportable", - "required": false, - "type": "boolean" + "name": "id", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,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", + "required": true, + "type": "uuid" }, { - "description": "the account to associate with this IP address", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the availability zone you want to acquire an public IP address from", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the VPC you want the IP address to be associated with", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "region ID from where portable IP is to be associated.", + "description": "an optional project for the ssh key", "length": 255, - "name": "regionid", + "name": "projectid", "related": "", "required": false, - "type": "integer" - }, - { - "description": "the ID of the domain to associate with this IP address", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, "type": "uuid" } ], - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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", "response": [ { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, + {}, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "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", - "name": "purpose", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the affinity group belongs to", "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the type of the affinity group", + "name": "type", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "public IP address id", - "name": "id", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, - {}, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, - {}, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - } - ] - }, - { - "description": "Get the SF Volume Access Group IDs", - "isasync": false, - "name": "getSolidFireVolumeAccessGroupIds", - "params": [ - { - "description": "Cluster UUID", - "length": 255, - "name": "clusterid", - "required": true, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + {}, { - "description": "Storage Pool UUID", - "length": 255, - "name": "storageid", - "required": true, + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "type": "long[]" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} - ] - }, - { - "description": "Delete site to site vpn connection", - "isasync": true, - "name": "deleteVpnConnection", - "params": [ - { - "description": "id of vpn connection", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Lists all alerts types", - "isasync": false, - "name": "listAlertTypes", - "params": [], - "related": "listAlerts", - "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the alert", - "name": "name", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "description of the alert", - "name": "description", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date and time the alert was sent", - "name": "sent", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" - }, - {}, - { - "description": "the id of the alert", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createNetworkACL", - "params": [ - { - "description": "the ending port of ACL", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "The network of the VM the ACL will be created for", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" - }, - { - "description": "The number of the ACL item, its ordering", - "length": 255, - "name": "number", - "required": false, - "type": "integer" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "scl entry action, allow or deny", - "length": 255, - "name": "action", - "required": false, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the starting port of ACL", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "The network of the VM the ACL will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "updateNetworkACLItem,moveNetworkAclItem", - "response": [ - { - "description": "the state of the rule", - "name": "state", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, - {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, {}, { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" - } - ] - }, - { - "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", - "isasync": true, - "name": "resetSSHKeyForVirtualMachine", - "params": [ + }, { - "description": "names of the ssh key pairs to be used to login to the virtual machine", - "length": 255, - "name": "keypairs", - "required": false, - "since": "4.17", - "type": "list" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "required": false, - "type": "string" - } - ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "response": [ + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, { "description": "the extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -119494,54 +130795,54 @@ "type": "list" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { "description": "true if nic is default, false otherwise", @@ -119549,13 +130850,8 @@ "type": "boolean" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -119564,13 +130860,23 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -119589,65 +130895,95 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { "description": "the netmask of the nic", "name": "netmask", "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" } ], "type": "set" }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -119656,13 +130992,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -119671,51 +131007,26 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, { "description": "User VM type", "name": "vmtype", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { @@ -119723,360 +131034,53 @@ "name": "rootdevicetype", "type": "string" }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, { "description": "the number of vCPUs this virtual machine is using", "name": "cpunumber", "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, - {}, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -120084,8 +131088,13 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -120094,13 +131103,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -120108,65 +131117,90 @@ "name": "resourcetype", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -120175,18 +131209,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -120195,61 +131229,93 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -120258,267 +131324,102 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - {}, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - {}, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" } ] }, @@ -120528,16 +131429,16 @@ "name": "deleteManagementNetworkIpRange", "params": [ { - "description": "The starting IP address.", + "description": "The vlan id the ip range sits on", "length": 255, - "name": "startip", + "name": "vlan", "required": true, "type": "string" }, { - "description": "The vlan id the ip range sits on", + "description": "The starting IP address.", "length": 255, - "name": "vlan", + "name": "startip", "required": true, "type": "string" }, @@ -120558,6 +131459,13 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -120568,18 +131476,11 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.11.0.0" }, @@ -120589,12 +131490,19 @@ "name": "addKubernetesSupportedVersion", "params": [ { - "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "directdownload", + "name": "mincpunumber", + "required": true, + "type": "integer" + }, + { + "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", "required": false, - "since": "4.18.2", - "type": "boolean" + "since": "4.20", + "type": "string" }, { "description": "the ID of the zone in which Kubernetes supported version will be available", @@ -120605,25 +131513,10 @@ "type": "uuid" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", - "length": 255, - "name": "url", - "required": false, - "type": "string" - }, - { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", - "length": 255, - "name": "minmemory", - "required": true, - "type": "integer" - }, - { - "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "arch", + "name": "name", "required": false, - "since": "4.20", "type": "string" }, { @@ -120641,16 +131534,24 @@ "type": "string" }, { - "description": "the name of the Kubernetes supported version", + "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", "length": 255, - "name": "name", + "name": "directdownload", + "required": false, + "since": "4.18.2", + "type": "boolean" + }, + { + "description": "the URL of the binaries ISO for Kubernetes supported version", + "length": 255, + "name": "url", "required": false, "type": "string" }, { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "the minimum RAM size in MB to be set with the Kubernetes version", "length": 255, - "name": "mincpunumber", + "name": "minmemory", "required": true, "type": "integer" } @@ -120658,14 +131559,14 @@ "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Name of the Kubernetes supported version", @@ -120673,39 +131574,66 @@ "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" + }, + { + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, + {}, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" }, { "description": "the date when this Kubernetes supported version was created", "name": "created", "type": "date" }, + {}, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" + }, + { + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" + }, + { + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, + { + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, { "description": "the id of the Kubernetes supported version", "name": "id", "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { "description": "whether Kubernetes supported version supports Autoscaling", @@ -120713,43 +131641,92 @@ "type": "boolean" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" + } + ] + }, + { + "description": "Register a CNI Configuration to be used with CKS cluster", + "isasync": false, + "name": "registerCniConfiguration", + "params": [ + { + "description": "an optional project for the user data", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "an optional account for the user data. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, - {}, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "Name of the user data", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "CNI Configuration content to be registered as User data", + "length": 1048576, + "name": "cniconfig", + "required": false, "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "comma separated list of variables declared in user data content", + "length": 255, + "name": "params", + "required": false, "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", + "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {} - ] + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.21.0" }, { "description": "Link or unlink a userdata to a template.", @@ -120760,59 +131737,109 @@ "description": "the ID of the template for the virtual machine", "length": 255, "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "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", + "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", "length": 255, - "name": "userdataid", - "related": "", + "name": "userdatapolicy", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", + "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", "length": 255, - "name": "userdatapolicy", + "name": "userdataid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the ISO for the virtual machine", "length": 255, "name": "isoid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" } ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, { "description": "the template display text", "name": "displaytext", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "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", - "name": "userdataparams", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { @@ -120820,13 +131847,8 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -120835,28 +131857,28 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -120865,37 +131887,58 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "Base64 string representation of the resource icon", @@ -120903,49 +131946,55 @@ "type": "resourceiconresponse" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, + {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the URL which the template/iso is registered from", @@ -120953,59 +132002,93 @@ "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "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", + "name": "userdataparams", "type": "string" }, - {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, { "description": "the physical size of the template", "name": "physicalsize", "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the template name", + "name": "name", "type": "string" }, { @@ -121013,91 +132096,181 @@ "name": "size", "type": "long" }, + {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + } + ], + "since": "4.18.0" + }, + { + "description": "Lists the custom actions", + "isasync": false, + "name": "listCustomActions", + "params": [ + { + "description": "Name of the custom action", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "uuid of the custom action", + "length": 255, + "name": "id", + "related": "listCustomActions", + "required": false, + "type": "uuid" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "ID of a resource for actions", + "length": 255, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "uuid of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions,updateExtension", + "required": false, + "type": "uuid" + }, + { + "description": "List actions whether they are enabled or not", + "length": 255, + "name": "enabled", + "required": false, "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Type of the resource for actions", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Whether the custom action is enabled or not", + "name": "enabled", "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "Name of the extension that this custom action belongs to", + "name": "extensionname", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "ID of the extension that this custom action belongs to", + "name": "extensionid", + "type": "string" }, - {}, { - "description": "the template ID", - "name": "id", + "description": "Creation timestamp of the custom action", + "name": "created", + "type": "date" + }, + { + "description": "Name of the custom action", + "name": "name", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "Details of the custom action", + "name": "details", + "type": "map" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "Message that will be used on successful execution of the action", + "name": "successmessage", "type": "string" }, + {}, + {}, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Description of the custom action", + "name": "description", + "type": "string" + }, + { + "description": "List of the parameters for the action", + "name": "parameters", + "response": [ + { + "description": "Whether the parameter is required or not", + "name": "required", + "type": "boolean" + }, + { + "description": "Comma-separated list of options for value of the parameter", + "name": "valueoptions", + "type": "list" + }, + { + "description": "Type of the parameter", + "name": "type", + "type": "string" + }, + { + "description": "Validation format for value of the parameter. Available for specific types", + "name": "validationformat", + "type": "string" + }, + { + "description": "Name of the parameter", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", @@ -121105,32 +132278,37 @@ "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "Resource type for which the action is available", + "name": "resourcetype", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "Specifies the timeout in seconds to wait for the action to complete before failing", + "name": "timeout", + "type": "integer" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "ID of the custom action", + "name": "id", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the template", - "name": "project", + "description": "List of role types allowed for the custom action", + "name": "allowedroletypes", + "type": "list" + }, + { + "description": "Message that will be used on failure during execution of the action", + "name": "errormessage", "type": "string" } ], - "since": "4.18.0" + "since": "4.21.0" }, { "description": "Lists load balancer rules.", @@ -121138,26 +132316,40 @@ "name": "listGlobalLoadBalancerRules", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, "type": "uuid" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "page", + "name": "tags", "required": false, - "type": "integer" + "type": "map" + }, + { + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "region ID", @@ -121168,17 +132360,17 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "keyword", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the global load balancer rule", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -121191,79 +132383,50 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "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.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "List resources by tags (key/value pairs)", + "description": "List by keyword", "length": 255, - "name": "tags", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the private port", + "name": "privateport", "type": "string" }, { @@ -121272,43 +132435,23 @@ "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the load balancer rule ID", - "name": "id", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { @@ -121316,23 +132459,23 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -121341,46 +132484,46 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "the private port", - "name": "privateport", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -121388,19 +132531,34 @@ "name": "publicport", "type": "string" }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { "description": "the domain of the load balancer rule", "name": "domain", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -121409,31 +132567,51 @@ "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" } ], "type": "list" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { @@ -121442,13 +132620,23 @@ "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { @@ -121456,27 +132644,17 @@ "name": "regionid", "type": "integer" }, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, { "description": "global load balancer rule ID", "name": "id", "type": "string" }, - {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -121494,27 +132672,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, {} ] }, @@ -121534,25 +132712,25 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -121573,16 +132751,17 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Name of the container cluster", "name": "name", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the id of the container cluster", "name": "id", @@ -121593,11 +132772,10 @@ "name": "configdata", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ] @@ -121617,27 +132795,27 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, {} ] }, @@ -121656,23 +132834,23 @@ } ], "response": [ + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -121696,26 +132874,26 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -121726,10 +132904,18 @@ "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "the ID of the Internal LB VM", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", + "type": "boolean" + }, + { + "description": "List Internal LB VMs by VPC", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, @@ -121741,109 +132927,109 @@ "type": "string" }, { - "description": "List by keyword", + "description": "the Zone ID of the Internal LB VM", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Pod ID of the Internal LB VM", + "description": "list by network id", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "the Zone ID of the Internal LB VM", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the host ID of the Internal LB VM", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "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.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "the host ID of the Internal LB VM", "length": 255, - "name": "fetchhealthcheckresults", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "description": "the name of the Internal LB VM", "length": 255, - "name": "forvpc", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list by network id", + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "forvpc", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the Internal LB VM", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the Internal LB VM", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "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", "required": false, "type": "uuid" }, { - "description": "List Internal LB VMs by VPC", + "description": "the Pod ID of the Internal LB VM", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "", + "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.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "", @@ -121851,21 +133037,33 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "listRouters", "response": [ { - "description": "the name of the router", - "name": "name", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { @@ -121874,8 +133072,28 @@ "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", "type": "string" }, { @@ -121884,70 +133102,43 @@ "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { @@ -121956,51 +133147,71 @@ "type": "boolean" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, {}, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, { "description": "the list of nics associated with the router", "name": "nic", @@ -122011,231 +133222,233 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" } ], - "type": "set" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" + "type": "list" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { @@ -122243,25 +133456,15 @@ "name": "podname", "type": "string" }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, { "description": "the ID of the corresponding public network", "name": "publicnetworkid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the account associated with the router", @@ -122269,71 +133472,46 @@ "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - {}, { "description": "the second DNS for the router", "name": "dns2", "type": "string" }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, { "description": "the Zone name for the router", "name": "zonename", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - } + {} ] }, { @@ -122341,55 +133519,46 @@ "isasync": false, "name": "listCiscoVnmcResources", "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Cisco VNMC resource ID", + "description": "List by keyword", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "Cisco VNMC resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - {}, - {}, {}, {}, { @@ -122397,6 +133566,15 @@ "name": "jobid", "type": "string" }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, {} ] }, @@ -122405,13 +133583,6 @@ "isasync": true, "name": "executeClusterDrsPlan", "params": [ - { - "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", - "length": 255, - "name": "migrateto", - "required": false, - "type": "map" - }, { "description": "ID of cluster", "length": 255, @@ -122419,21 +133590,23 @@ "related": "addCluster,updateCluster", "required": true, "type": "uuid" + }, + { + "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "length": 255, + "name": "migrateto", + "required": false, + "type": "map" } ], "related": "", "response": [ + {}, { "description": "Id of the cluster", "name": "clusterid", "type": "string" }, - { - "description": "Start event Id of the DRS Plan", - "name": "eventid", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -122441,31 +133614,36 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "unique ID of the drs plan for cluster", - "name": "id", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, { "description": "Status of DRS Plan", "name": "status", "type": "status" }, - {}, + { + "description": "Start event Id of the DRS Plan", + "name": "eventid", + "type": "string" + }, { "description": "Type of DRS Plan (Automated or Manual))", "name": "type", "type": "type" }, { - "description": "List of migrations", - "name": "migrations", - "type": "list" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "unique ID of the drs plan for cluster", + "name": "id", + "type": "string" + }, + {} ], "since": "4.19.0" }, @@ -122485,26 +133663,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "3.0.0" @@ -122515,16 +133693,16 @@ "name": "uploadResourceIcon", "params": [ { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", + "description": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", "required": true, "type": "string" }, { - "description": "Base64 string representation of the resource icon/image", - "length": 2097152, - "name": "base64image", + "description": "type of the resource", + "length": 255, + "name": "resourcetype", "required": true, "type": "string" }, @@ -122537,27 +133715,27 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ], "since": "4.16.0.0" @@ -122585,34 +133763,29 @@ ], "related": "listKubernetesSupportedVersions", "response": [ - { - "description": "the id of the Kubernetes supported version", - "name": "id", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", + "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", "type": "boolean" }, { @@ -122621,30 +133794,36 @@ "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, + {}, { "description": "the state of the binaries ISO for Kubernetes supported version", "name": "isostate", "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { "description": "the name of the binaries ISO for Kubernetes supported version", "name": "isoname", "type": "string" }, + { + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" + }, {}, { "description": "the enabled or disabled state of the Kubernetes supported version", @@ -122652,29 +133831,28 @@ "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, - {}, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" } ] @@ -122694,28 +133872,28 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "4.20.0" }, @@ -122743,52 +133921,52 @@ "related": "listGuestNetworkIpv6Prefixes", "response": [ { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" }, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", + "type": "string" + }, + {}, { "description": "count of the used IPv6 subnets for the prefix.", "name": "usedsubnets", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "guest IPv6 prefix", "name": "prefix", "type": "string" }, - { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "type": "string" - }, { "description": "count of the available IPv6 subnets for the prefix.", "name": "availablesubnets", "type": "integer" }, { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" }, { "description": "count of the total IPv6 subnets for the prefix.", "name": "totalsubnets", "type": "integer" - }, - {}, - {} + } ], "since": "4.17.0.0" }, @@ -122805,18 +133983,10 @@ "type": "boolean" }, { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", - "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "Creates a role with this unique name", "length": 255, - "name": "type", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -122827,11 +133997,19 @@ "type": "string" }, { - "description": "Creates a role with this unique name", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "name", - "required": true, + "name": "type", + "required": false, "type": "string" + }, + { + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": false, + "type": "uuid" } ], "related": "listRoles,updateRole", @@ -122847,14 +134025,14 @@ "type": "boolean" }, { - "description": "the name of the role", - "name": "name", + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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).", + "name": "ispublic", + "type": "boolean" }, { "description": "the ID of the role", @@ -122862,27 +134040,27 @@ "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "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).", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, + {}, { - "description": "the state of the role", - "name": "state", + "description": "the description of the role", + "name": "description", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.9.0" }, @@ -122892,40 +134070,23 @@ "name": "getUploadParamsForVolume", "params": [ { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", + "description": "Image store uuid", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "imagestoreuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "the name of the volume/template/iso", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" - }, - { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, "type": "string" }, { - "description": "Upload volume/template/iso for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the volume/template/iso", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, @@ -122937,9 +134098,9 @@ "type": "string" }, { - "description": "Image store uuid", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "imagestoreuuid", + "name": "account", "required": false, "type": "string" }, @@ -122952,20 +134113,41 @@ "type": "uuid" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "format", + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the zone the volume/template/iso is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ - {}, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" + }, + { + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" }, { "description": "the timestamp after which the signature expires", @@ -122977,15 +134159,10 @@ "name": "id", "type": "uuid" }, - { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" - }, {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -122993,10 +134170,11 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" } ], "since": "4.6.0" @@ -123006,14 +134184,6 @@ "isasync": true, "name": "updateAutoScaleVmProfile", "params": [ - { - "description": "the ID of the autoscale vm profile", - "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" - }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -123023,20 +134193,19 @@ "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18.1", - "type": "map" + "name": "id", + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "fordisplay", + "name": "expungevmgraceperiod", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { "description": "the ID of the userdata", @@ -123048,26 +134217,28 @@ "type": "uuid" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \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\".", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "otherdeployparams", + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.18.0", - "type": "map" + "type": "uuid" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "expungevmgraceperiod", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the template of the auto deployed virtual machine", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.18.0", "type": "uuid" }, { @@ -123079,13 +134250,19 @@ "type": "uuid" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "counterparam", + "required": false, + "type": "map" + }, + { + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \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\".", + "length": 255, + "name": "otherdeployparams", "required": false, "since": "4.18.0", - "type": "uuid" + "type": "map" }, { "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", @@ -123096,122 +134273,123 @@ "type": "string" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "counterparam", + "name": "userdatadetails", "required": false, + "since": "4.18.1", "type": "map" } ], "related": "listAutoScaleVmProfiles", "response": [ { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "the autoscale vm profile ID", + "name": "id", + "type": "string" }, { "description": "the project id vm profile", "name": "projectid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, - {}, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, + {}, { "description": "the project name of the vm profile", "name": "project", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" - }, - { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, {}, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, - {}, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" } ] @@ -123233,74 +134411,70 @@ "related": "", "response": [ { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, + {}, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { "description": "the public ip address", @@ -123308,64 +134482,68 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", "type": "int" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, - {}, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { @@ -123375,9 +134553,9 @@ }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the public port", + "name": "publicport", + "type": "string" } ] }, @@ -123386,13 +134564,6 @@ "isasync": false, "name": "listGuestNetworkIpv6Prefixes", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "UUID of the IPv6 prefix.", "length": 255, @@ -123402,12 +134573,11 @@ "type": "uuid" }, { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -123417,29 +134587,32 @@ "type": "integer" }, { - "description": "", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" - }, - { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, {}, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -123447,16 +134620,10 @@ "name": "usedsubnets", "type": "integer" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "guest IPv6 prefix", - "name": "prefix", - "type": "string" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" }, { "description": "id of zone to which the IPv6 prefix belongs to.", @@ -123469,9 +134636,20 @@ "type": "string" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" + }, + { + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, + {}, + { + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" } ], "since": "4.17.0" @@ -123482,11 +134660,12 @@ "name": "updateGuestOsMapping", "params": [ { - "description": "Hypervisor specific name for this Guest OS", + "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", "length": 255, - "name": "osnameforhypervisor", - "required": true, - "type": "string" + "name": "osmappingcheckenabled", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { "description": "UUID of the Guest OS to hypervisor name Mapping", @@ -123497,63 +134676,62 @@ "type": "uuid" }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", + "description": "Hypervisor specific name for this Guest OS", "length": 255, - "name": "osmappingcheckenabled", - "required": false, - "since": "4.19.0", - "type": "boolean" + "name": "osnameforhypervisor", + "required": true, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, + {}, { "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" - }, - {} + } ], "since": "4.4.0" }, @@ -123563,19 +134741,19 @@ "name": "deleteTungstenFabricTag", "params": [ { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "taguuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the ID of zone", "length": 255, - "name": "taguuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ @@ -123585,22 +134763,22 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -123609,11 +134787,12 @@ "name": "updateHostPassword", "params": [ { - "description": "if the password should also be updated on the hosts", + "description": "the host ID", "length": 255, - "name": "update_passwd_on_host", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the new password for the host/cluster", @@ -123623,20 +134802,19 @@ "type": "string" }, { - "description": "the host ID", + "description": "the cluster ID", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the cluster ID", + "description": "if the password should also be updated on the hosts", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "update_passwd_on_host", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the username for the host/cluster", @@ -123647,15 +134825,9 @@ } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -123664,11 +134836,17 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -123677,16 +134855,17 @@ "name": "createPortableIpRange", "params": [ { - "description": "the ending IP address in the portable IP range", + "description": "Id of the Region", "length": 255, - "name": "endip", + "name": "regionid", + "related": "", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the netmask of the portable IP range", + "description": "the gateway for the portable IP range", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, @@ -123698,63 +134877,69 @@ "type": "string" }, { - "description": "the gateway for the portable IP range", + "description": "the ending IP address in the portable IP range", "length": 255, - "name": "gateway", + "name": "endip", "required": true, "type": "string" }, { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "the netmask of the portable IP range", "length": 255, - "name": "vlan", - "required": false, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "Id of the Region", + "description": "VLAN id, if not specified defaulted to untagged", "length": 255, - "name": "regionid", - "related": "", - "required": true, - "type": "integer" + "name": "vlan", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "portable IP range ID", + "name": "id", + "type": "string" }, { "description": "Region Id in which portable ip range is provisioned", "name": "regionid", "type": "integer" }, + {}, { - "description": "the end ip of the portable IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the gateway of the VLAN IP range", "name": "gateway", "type": "string" }, + {}, { "description": "the start ip of the portable IP range", "name": "startip", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, { @@ -123762,8 +134947,6 @@ "name": "vlan", "type": "string" }, - {}, - {}, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", @@ -123773,24 +134956,19 @@ "name": "allocated", "type": "date" }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, { "description": "public IP address", "name": "ipaddress", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { @@ -123803,28 +134981,28 @@ "name": "physicalnetworkid", "type": "string" }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, { "description": "Region Id in which global load balancer is created", "name": "regionid", "type": "integer" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" } ], "type": "list" - }, - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" } ], "since": "4.2.0" @@ -123835,27 +135013,26 @@ "name": "deleteWebhookDelivery", "params": [ { - "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.", + "description": "The ID of the management server", "length": 255, - "name": "enddate", + "name": "managementserverid", + "related": "", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "The ID of the Webhook", + "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.", "length": 255, - "name": "webhookid", - "related": "createWebhook", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "The ID of the management server", + "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.", "length": 255, - "name": "managementserverid", - "related": "", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { "description": "The ID of the Webhook delivery", @@ -123866,36 +135043,37 @@ "type": "uuid" }, { - "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.", + "description": "The ID of the Webhook", "length": 255, - "name": "startdate", + "name": "webhookid", + "related": "createWebhook", "required": false, - "type": "date" + "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {}, + {} ], "since": "4.20.0" }, @@ -123905,18 +135083,18 @@ "name": "updateCluster", "params": [ { - "description": "hypervisor type of the cluster", + "description": "the ID of the Cluster", "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "arch", + "name": "managedstate", "required": false, - "since": "4.20", "type": "string" }, { @@ -123927,25 +135105,18 @@ "type": "string" }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "whether this cluster is managed by cloudstack", + "description": "the cluster name", "length": 255, - "name": "managedstate", + "name": "clustername", "required": false, "type": "string" }, { - "description": "the cluster name", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "clustername", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { @@ -123954,73 +135125,39 @@ "name": "allocationstate", "required": false, "type": "string" - } - ], - "related": "addCluster", - "response": [ - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "the cluster ID", - "name": "id", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" + "description": "Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].=. Example: externaldetails[0].endpoint.url=https://example.com", + "length": 255, + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, + } + ], + "related": "addCluster", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, + {}, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the Zone ID", @@ -124028,14 +135165,14 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { "description": "the Pod name", @@ -124043,18 +135180,18 @@ "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -124068,44 +135205,44 @@ "type": "long" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" } ], "type": "list" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, + {}, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, - {}, { "description": "the hypervisor type of the cluster", "name": "hypervisortype", @@ -124116,12 +135253,87 @@ "name": "clustertype", "type": "string" }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "The cpu overcommit ratio of the cluster", "name": "cpuovercommitratio", "type": "string" }, - {} + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + {}, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", + "type": "string" + } ] }, { @@ -124130,18 +135342,11 @@ "name": "listVmwareDcVms", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "Name of the VM on vCenter. Must be set along with the hostname parameter", + "description": "", "length": 255, - "name": "instancename", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", @@ -124160,14 +135365,7 @@ { "description": "The Username required to connect to resource.", "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "Name of the host on vCenter. Must be set along with the instancename parameter", - "length": 255, - "name": "hostname", + "name": "username", "required": false, "type": "string" }, @@ -124186,6 +135384,13 @@ "required": false, "type": "string" }, + { + "description": "Name of the host on vCenter. Must be set along with the instancename parameter", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, { "description": "Name of VMware datacenter.", "length": 255, @@ -124194,28 +135399,45 @@ "type": "string" }, { - "description": "", + "description": "Name of the VM on vCenter. Must be set along with the hostname parameter", "length": 255, - "name": "page", + "name": "instancename", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "listUnmanagedInstances", "response": [ { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "indicates the boot mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, { "description": "the operating system of the virtual machine", "name": "osdisplayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { @@ -124223,48 +135445,53 @@ "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, { "description": "ID of the VLAN/VNI if available", "name": "vlanid", "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -124278,162 +135505,142 @@ "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "type": "string" - }, { - "description": "indicates the boot type", - "name": "boottype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, + {}, { - "description": "indicates the boot mode", - "name": "bootmode", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { "description": "the list of disks associated with the virtual machine", "name": "disk", "response": [ - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, { "description": "the controller of the disk", "name": "datastorename", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { "description": "the ID of the disk", @@ -124441,75 +135648,234 @@ "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "the position of the disk", + "name": "position", + "type": "integer" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the position of the disk", - "name": "position", + "description": "the controller unit of the disk", + "name": "controllerunit", "type": "integer" }, { "description": "the controller of the disk", - "name": "datastorehost", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" } ], "type": "set" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, + {}, { - "description": "the memory of the virtual machine in MB", - "name": "memory", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", "type": "integer" }, { "description": "the CPU cores of the virtual machine", "name": "cpunumber", "type": "integer" + } + ] + }, + { + "description": "Update the extension", + "isasync": false, + "name": "updateExtension", + "params": [ + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", + "length": 255, + "name": "orchestratorrequirespreparevm", + "required": false, + "type": "boolean" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "Description of the extension", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "State of the extension", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "The ID of the extension", + "length": 255, + "name": "id", + "related": "listExtensions,updateExtension", + "required": true, + "type": "uuid" + }, + { + "description": "Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this action, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + } + ], + "related": "listExtensions", + "response": [ + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + { + "description": "Name of the extension", + "name": "name", + "type": "string" + }, + { + "description": "Description of the extension", + "name": "description", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, {}, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "The state of the extension", + "name": "state", + "type": "string" + }, + { + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + } + ], + "type": "list" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } - ] + ], + "since": "4.21.0" }, { "description": "Lists storage providers.", @@ -124517,18 +135883,18 @@ "name": "listStorageProviders", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -124547,28 +135913,28 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the type of the storage provider: primary or image provider", - "name": "type", + "description": "the name of the storage provider", + "name": "name", "type": "string" }, {}, + {}, { - "description": "the name of the storage provider", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + { + "description": "the type of the storage provider: primary or image provider", + "name": "type", + "type": "string" + } ] }, { @@ -124590,6 +135956,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the id for the ucs manager", "length": 255, @@ -124597,13 +135970,6 @@ "related": "", "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", @@ -124614,7 +135980,6 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "ucs profile dn", "name": "ucsdn", @@ -124624,7 +135989,8 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -124643,31 +136009,31 @@ ], "related": "", "response": [ - {}, { "description": "the api key of the registered user", "name": "apikey", "type": "string" }, + { + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "whether api key access is allowed or not", "name": "apikeyaccess", "type": "boolean" }, - {}, { - "description": "the secret key of the registered user", - "name": "secretkey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -124679,117 +136045,97 @@ "name": "updateGlobalLoadBalancerRule", "params": [ { - "description": "the ID of the global load balancer rule", + "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", "length": 255, - "name": "id", - "related": "updateGlobalLoadBalancerRule", - "required": true, - "type": "uuid" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "name": "gslblbmethod", "required": false, "type": "string" }, { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "gslblbmethod", + "name": "gslbstickysessionmethodname", "required": false, "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "id", + "related": "updateGlobalLoadBalancerRule", + "required": true, + "type": "uuid" + }, + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", - "type": "string" - }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, + {}, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", - "type": "string" - }, - {}, - { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -124797,90 +136143,85 @@ "name": "loadbalancerrule", "response": [ { - "description": "the public ip address", - "name": "publicip", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { @@ -124889,13 +136230,8 @@ "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { @@ -124904,23 +136240,23 @@ "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -124929,13 +136265,13 @@ "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -124944,8 +136280,13 @@ "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -124954,59 +136295,32 @@ "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" } ], "type": "list" - } - ] - }, - { - "description": "Allow or disallow a user to use SAML SSO", - "isasync": false, - "name": "authorizeSamlSso", - "params": [ - { - "description": "User uuid", - "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", - "required": true, - "type": "uuid" - }, - { - "description": "The Identity Provider ID the user is allowed to get single signed on from", - "length": 255, - "name": "entityid", - "related": "listIdps", - "required": false, - "type": "string" }, { - "description": "If true, authorizes user to be able to use SAML for Single Sign. If False, disable user to user SAML SSO.", - "length": 255, - "name": "enable", - "required": true, - "type": "boolean" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -125014,12 +136328,10 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {} + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" + } ] }, { @@ -125030,42 +136342,41 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host tag", + "name": "name", "type": "string" }, + {}, { "description": "true if the host tag is implicit", "name": "isimplicit", "type": "boolean" }, - {}, { - "description": "the name of the host tag", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -125082,7 +136393,8 @@ "description": "the ID of the host tag", "name": "id", "type": "string" - } + }, + {} ] }, { @@ -125090,14 +136402,6 @@ "isasync": true, "name": "addGuestOs", "params": [ - { - "description": "ID of Guest OS category", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": true, - "type": "uuid" - }, { "description": "Optional name for Guest OS", "length": 255, @@ -125106,11 +136410,11 @@ "type": "string" }, { - "description": "whether this guest OS is available for end users", + "description": "Unique display name for Guest OS", "length": 255, - "name": "forDisplay", - "required": false, - "type": "boolean" + "name": "osdisplayname", + "required": true, + "type": "string" }, { "description": "Map of (key/value pairs)", @@ -125120,32 +136424,40 @@ "type": "map" }, { - "description": "Unique display name for Guest OS", + "description": "ID of Guest OS category", "length": 255, - "name": "osdisplayname", + "name": "oscategoryid", + "related": "listOsCategories", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, + "type": "boolean" } ], "related": "", "response": [ + {}, { "description": "the name of the OS type", "name": "name", "type": "string" }, - {}, - {}, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, + {}, { "description": "is the guest OS visible for the users", "name": "fordisplay", @@ -125156,25 +136468,25 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the ID of the OS category", - "name": "oscategoryid", - "type": "string" - }, { "description": "the ID of the OS type", "name": "id", "type": "string" }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, { "description": "the name of the OS category", "name": "oscategoryname", "type": "string" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.4.0" @@ -125184,6 +136496,13 @@ "isasync": false, "name": "addAnnotation", "params": [ + { + "description": "the id of the entity to annotate", + "length": 255, + "name": "entityid", + "required": false, + "type": "string" + }, { "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", "length": 255, @@ -125205,35 +136524,18 @@ "name": "annotation", "required": false, "type": "string" - }, - { - "description": "the id of the entity to annotate", - "length": 255, - "name": "entityid", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" - }, - { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" - }, - { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -125242,19 +136544,8 @@ "type": "date" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { @@ -125263,59 +136554,44 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, - { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" - }, { "description": "the (uu)id of the annotation", "name": "id", "type": "string" }, - {} - ], - "since": "4.11" - }, - { - "description": "Returns list of discovered SAML Identity Providers", - "isasync": false, - "name": "listIdps", - "params": [], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "The IdP Entity ID", - "name": "id", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, - {}, { - "description": "The IdP Organization Name", - "name": "orgName", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "The IdP Organization URL", - "name": "orgUrl", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} - ] + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + } + ], + "since": "4.11" }, { "description": "Creates new NS Vpx", @@ -125323,10 +136599,10 @@ "name": "deployNetscalerVpx", "params": [ { - "description": "availability zone for the virtual machine", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, @@ -125342,15 +136618,15 @@ "description": "the ID of the template for the virtual machine", "length": 255, "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "availability zone for the virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" } @@ -125358,30 +136634,40 @@ "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", "response": [ { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" }, { "description": "device capacity", "name": "lbdevicecapacity", "type": "long" }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "device id of the netscaler load balancer", "name": "lbdeviceid", @@ -125393,56 +136679,46 @@ "type": "boolean" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device name", + "name": "lbdevicename", "type": "string" }, - {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, + {}, { "description": "the management IP address of the external load balancer", "name": "ipaddress", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -125461,25 +136737,25 @@ ], "related": "", "response": [ - {}, { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "synchronization", - "name": "sync", + "description": "compression", + "name": "compression", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { @@ -125488,19 +136764,19 @@ "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the name of the volume", + "name": "name", "type": "string" }, - {}, { "description": "the id of the volume", "name": "id", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "synchronization", + "name": "sync", "type": "string" } ] @@ -125518,18 +136794,19 @@ "type": "string" }, { - "description": "Tftp root directory of PXE server", + "description": "type of pxe device", "length": 255, - "name": "tftpdir", + "name": "pxeservertype", "required": true, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Pod Id", @@ -125540,35 +136817,29 @@ "type": "uuid" }, { - "description": "type of pxe device", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "pxeservertype", + "name": "username", "required": true, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "password", + "name": "tftpdir", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "password", "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "url", "name": "url", @@ -125576,13 +136847,18 @@ }, {}, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "device id of ", - "name": "id", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, { @@ -125595,12 +136871,12 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -125609,12 +136885,18 @@ "name": "listNiciraNvpDevices", "params": [ { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -125624,11 +136906,12 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "nicira nvp device ID", @@ -125637,13 +136920,6 @@ "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "addNiciraNvpDevice", @@ -125653,41 +136929,41 @@ "name": "l2gatewayserviceuuid", "type": "string" }, - {}, { "description": "the physical network to which this Nirica Nvp belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "device name", - "name": "niciradevicename", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -125696,8 +136972,8 @@ "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the controller Ip address", + "name": "hostname", "type": "string" } ] @@ -125707,6 +136983,13 @@ "isasync": false, "name": "listAlerts", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list by alert name", "length": 255, @@ -125718,17 +137001,10 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "list by alert type", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { "description": "the ID of the alert", "length": 255, @@ -125738,58 +137014,58 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "list by alert type", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the id of the alert", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "description of the alert", + "name": "description", + "type": "string" + }, + { + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" }, { "description": "the name of the alert", "name": "name", "type": "string" }, + {}, { - "description": "description of the alert", - "name": "description", + "description": "the id of the alert", + "name": "id", "type": "string" }, + {}, { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", "name": "type", "type": "short" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -125799,12 +137075,12 @@ "name": "deployVirtualMachine", "params": [ { - "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", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "bootintosetup", "required": false, - "type": "list" + "since": "4.15.0.0", + "type": "boolean" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -125814,89 +137090,91 @@ "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "the ID of the Userdata", "length": 255, - "name": "size", + "name": "userdataid", + "related": "", "required": false, - "type": "long" + "since": "4.18", + "type": "uuid" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "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", "length": 255, - "name": "bootintosetup", + "name": "rootdisksize", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "since": "4.4", + "type": "long" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "host name for the virtual machine", "length": 255, - "name": "startvm", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "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", "length": 255, - "name": "displayvm", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.2", - "type": "boolean" + "type": "map" }, { - "description": "the ID of the Userdata", + "description": "Number of days instance is leased for.", "length": 255, - "name": "userdataid", - "related": "", + "name": "leaseduration", "required": false, - "since": "4.18", - "type": "uuid" + "since": "4.21.0", + "type": "integer" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "nicmultiqueuenumber", + "name": "ip6address", "required": false, - "since": "4.18", - "type": "integer" + "type": "string" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "list" + "since": "4.21", + "type": "uuid" }, { - "description": "the ip address for default vm's network", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "ipaddress", + "name": "leaseexpiryaction", "required": false, + "since": "4.21.0", "type": "string" }, { - "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.", + "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", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "overridediskofferingid", + "related": "", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", - "length": 255, - "name": "password", + "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", + "length": 1048576, + "name": "userdata", "required": false, - "since": "4.19.0.0", "type": "string" }, { - "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", + "description": "Deploy vm for the project", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "projectid", + "related": "", "required": false, - "type": "map" + "type": "uuid" }, { "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.", @@ -125906,13 +137184,19 @@ "type": "boolean" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "account", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" + }, + { + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "list" }, { "description": "an optional group for the virtual machine", @@ -125922,86 +137206,87 @@ "type": "string" }, { - "description": "the ipv6 address for default vm's network", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "ip6address", + "name": "displayname", "required": false, "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "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.", "length": 255, - "name": "userdatadetails", + "name": "diskofferingid", + "related": "", "required": false, - "since": "4.18", - "type": "map" + "type": "uuid" }, { - "description": "host name for the virtual machine", + "description": "Controls specific policies on IO", "length": 255, - "name": "name", + "name": "iodriverpolicy", "required": false, "type": "string" }, { - "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.", + "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", "length": 255, - "name": "diskofferingid", + "name": "securitygroupnames", "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the mac address for default vm's network", + "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", "length": 255, - "name": "macaddress", + "name": "keyboard", "required": false, "type": "string" }, { - "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", + "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", "length": 255, - "name": "securitygroupnames", + "name": "securitygroupids", "related": "", "required": false, "type": "list" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "externaldetails", + "required": false, + "since": "4.21.0", + "type": "map" }, { - "description": "Enable packed virtqueues or not.", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "affinitygroupids", + "related": "", "required": false, - "since": "4.18", - "type": "boolean" + "type": "list" }, { - "description": "an optional user generated name for the virtual machine", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "displayname", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "deploymentplanner", + "name": "keypairs", "required": false, - "since": "4.4", - "type": "string" + "since": "4.17", + "type": "list" }, { - "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", + "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", "length": 255, - "name": "iptonetworklist", + "name": "datadisksdetails", "required": false, + "since": "4.21.0", "type": "map" }, { @@ -126014,80 +137299,73 @@ "type": "uuid" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", - "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "dynamicscalingenabled", + "name": "displayvm", "required": false, - "since": "4.16", + "since": "4.2", "type": "boolean" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "the mac address for default vm's network", "length": 255, - "name": "keypair", + "name": "macaddress", "required": false, "type": "string" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "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", "length": 255, - "name": "copyimagetags", + "name": "iptonetworklist", "required": false, - "since": "4.13", - "type": "boolean" + "type": "map" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "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", + "length": 255, + "name": "hypervisor", "required": false, - "since": "4.12", "type": "string" }, { - "description": "availability zone for the virtual machine", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "since": "4.3", + "type": "map" }, { - "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", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "datadiskofferinglist", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "since": "4.11", - "type": "map" + "since": "4.13", + "type": "uuid" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", "length": 255, - "name": "keyboard", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "account", + "name": "keypair", "required": false, "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, + "since": "4.21", "type": "uuid" }, { @@ -126099,35 +137377,69 @@ "type": "string" }, { - "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", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "rootdisksize", + "name": "dynamicscalingenabled", "required": false, - "since": "4.4", - "type": "long" + "since": "4.16", + "type": "boolean" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "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.", "length": 255, - "name": "keypairs", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.17", - "type": "list" + "type": "uuid" }, { - "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", - "length": 1048576, - "name": "userdata", + "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", + "length": 255, + "name": "nicnetworklist", "required": false, - "type": "string" + "since": "4.15", + "type": "map" }, { - "description": "Controls specific policies on IO", + "description": "availability zone for the virtual machine", "length": 255, - "name": "iodriverpolicy", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, + "since": "4.12", "type": "string" }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "The number of queues for multiqueue NICs.", + "length": 255, + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" + }, { "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.", "length": 255, @@ -126137,20 +137449,35 @@ "type": "string" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "details", + "name": "deploymentplanner", "required": false, - "since": "4.3", - "type": "map" + "since": "4.4", + "type": "string" }, { - "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", + "description": "the ip address for default vm's network", "length": 255, - "name": "nicnetworklist", + "name": "ipaddress", "required": false, - "since": "4.15", - "type": "map" + "type": "string" + }, + { + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { "description": "used to specify the vApp properties.", @@ -126161,335 +137488,131 @@ "type": "map" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "copyimagetags", "required": false, - "type": "list" + "since": "4.13", + "type": "boolean" }, { - "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", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "hypervisor", + "name": "password", "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "the ID of the template for the virtual machine", + "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", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "datadiskofferinglist", + "required": false, + "since": "4.11", + "type": "map" }, { - "description": "Deploy vm for the project", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "projectid", - "related": "", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "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", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "overridediskofferingid", - "related": "", + "name": "startvm", "required": false, - "since": "4.17", - "type": "uuid" + "type": "boolean" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - } - ], - "type": "set" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "ssh key-pairs", @@ -126497,39 +137620,34 @@ "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { "description": "the userdata override policy with the userdata provided while deploying VM", @@ -126537,238 +137655,119 @@ "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, + {}, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, - {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { @@ -126777,81 +137776,66 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -126860,80 +137844,75 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" } ], "type": "set" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project id of the group", + "name": "projectid", + "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -126941,28 +137920,28 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -126971,41 +137950,46 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -127017,56 +138001,61 @@ "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -127080,53 +138069,53 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -127138,131 +138127,228 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the domain name of the security group", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the project id of the group", + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" } ], "type": "set" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "an alternate display text of the ISO attached to the virtual machine", "name": "isodisplaytext", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { "description": "ID of AutoScale VM group", @@ -127270,8 +138356,80 @@ "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { @@ -127280,23 +138438,251 @@ "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" } ] @@ -127307,52 +138693,66 @@ "name": "listVolumes", "params": [ { - "description": "list volumes by disk offering", + "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.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listsystemvms", + "name": "isrecursive", "required": false, - "since": "4.18", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", "length": 255, - "name": "projectid", - "related": "", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.19.1", "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "list volumes on specified host", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "string" + "type": "integer" }, { - "description": "the name of the disk volume", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { "description": "list only volumes that are encrypted", @@ -127363,103 +138763,106 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the virtual machine", "length": 255, - "name": "isrecursive", + "name": "virtualmachineid", + "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", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "description": "list volumes by disk offering", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "diskofferingid", + "related": "", "required": false, - "since": "4.19.1", + "since": "4.4", "type": "uuid" }, { - "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.", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "listall", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the pod id the disk volume belongs to", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "ids", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "uuid" + "since": "4.9", + "type": "list" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "displayvolume", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the name of the disk volume", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the type of disk volume", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "displayvolume", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "page", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "integer" + "since": "4.3", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the type of disk volume", "length": 255, - "name": "tags", + "name": "type", "required": false, - "type": "map" + "type": "string" }, { - "description": "list volumes on specified host", + "description": "the ID of the disk volume", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "id", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -127469,90 +138872,93 @@ "type": "string" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the ID of the availability zone", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "ids", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "listsystemvms", "required": false, - "since": "4.9", - "type": "list" + "since": "4.18", + "type": "boolean" + } + ], + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the cluster id the disk volume belongs to", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" - } - ], - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -127561,20 +138967,44 @@ "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, { "description": "the boolean state of whether the volume is destroyed or not", "name": "destroyed", "type": "boolean" }, - {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { "description": "the bytes actually consumed on disk", @@ -127582,38 +139012,38 @@ "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { @@ -127622,33 +139052,18 @@ "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { @@ -127657,93 +139072,105 @@ "type": "date" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { "description": "true if the volume is extractable, false otherwise", "name": "isextractable", "type": "boolean" }, + {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the path of the volume", - "name": "path", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, + {}, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -127752,14 +139179,14 @@ "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { "description": "name of the primary storage hosting the disk volume", @@ -127767,28 +139194,33 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { @@ -127796,48 +139228,48 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -127846,94 +139278,87 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, - {}, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, { "description": "id of the virtual machine", "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the state of the disk volume", + "name": "state", "type": "string" - }, + } + ] + }, + { + "description": "Removes a Management Server.", + "isasync": false, + "name": "removeManagementServer", + "params": [ { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, + "description": "the ID of the Management Server", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {}, + {} ] }, { @@ -127941,6 +139366,14 @@ "isasync": true, "name": "createLBHealthCheckPolicy", "params": [ + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, @@ -127956,62 +139389,60 @@ "type": "integer" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "the ID of the load balancer rule", "length": 255, - "name": "healthythreshold", - "required": false, - "type": "integer" + "name": "lbruleid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the description of the load balancer health check policy", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "description", + "name": "responsetimeout", "required": false, - "type": "string" + "type": "integer" }, { - "description": "HTTP ping path", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "pingpath", + "name": "description", "required": false, "type": "string" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "fordisplay", + "name": "healthythreshold", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", + "description": "HTTP ping path", "length": 255, - "name": "responsetimeout", + "name": "pingpath", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" }, { "description": "the account of the HealthCheck policy", "name": "account", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the domain of the HealthCheck policy", "name": "domain", @@ -128019,24 +139450,33 @@ }, {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, - {}, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "the state of the policy", - "name": "state", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { "description": "the LB HealthCheck policy ID", @@ -128044,52 +139484,37 @@ "type": "string" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "Number of consecutive health check failures before declaring an instance unhealthy.", "name": "unhealthcheckthresshold", "type": "int" }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "Time to wait when receiving a response from the health check", "name": "responsetime", "type": "int" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" } ], "type": "list" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", - "type": "string" } ], "since": "4.2.0" @@ -128119,68 +139544,18 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "response": [ { - "description": "the filesystem format", - "name": "filesystem", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "description of the shared filesystem", - "name": "description", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { @@ -128188,38 +139563,38 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -128228,13 +139603,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -128246,13 +139621,8 @@ "type": "set" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { @@ -128261,124 +139631,63 @@ "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - {}, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -128386,8 +139695,13 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { @@ -128396,24 +139710,24 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "the ID of the nic", @@ -128421,38 +139735,38 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -128461,52 +139775,138 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" } ], "type": "list" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" + }, + {}, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, + {}, { "description": "Network ID of the shared filesystem", "name": "networkid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, - {}, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { @@ -128514,45 +139914,70 @@ "name": "sizegb", "type": "string" }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, + { + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" + }, { "description": "the project name of the shared filesystem", "name": "project", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" } ], "since": "4.20.0" @@ -128571,52 +139996,47 @@ "type": "uuid" } ], - "related": "disableUser,getUser,listUsers", - "response": [ - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, + "related": "disableUser,getUser,listUsers", + "response": [ { - "description": "the account name of the user", - "name": "account", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, + {}, { - "description": "the user ID", - "name": "id", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" }, - {}, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user state", + "name": "state", "type": "string" }, { @@ -128625,58 +140045,69 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user state", - "name": "state", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the user lastname", - "name": "lastname", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -128685,30 +140116,24 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" } ] }, @@ -128719,12 +140144,17 @@ "params": [], "related": "", "response": [ - {}, { "description": "the Cloudian connector enabled state", "name": "enabled", "type": "boolean" }, + { + "description": "the Cloudian Management Console base URL", + "name": "url", + "type": "string" + }, + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -128735,11 +140165,6 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the Cloudian Management Console base URL", - "name": "url", - "type": "string" } ], "since": "4.11.0" @@ -128750,41 +140175,17 @@ "name": "createNetwork", "params": [ { - "description": "the first IPv6 DNS for the network", - "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "the VPC network belongs to", + "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the AS Number of the network", - "length": 255, - "name": "asnumber", - "required": false, - "since": "4.20.0", - "type": "long" - }, - { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the beginning IP address in the network IP range", "length": 255, - "name": "ip6cidr", + "name": "startip", "required": false, "type": "string" }, @@ -128797,160 +140198,159 @@ "type": "uuid" }, { - "description": "MTU to be configured on the network VR's private interface(s)", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "privatemtu", + "name": "publicmtu", "required": false, "since": "4.18.0", "type": "integer" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "endipv6", + "name": "routerip", "required": false, + "since": "4.16", "type": "string" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "the VPC network belongs to", "length": 255, - "name": "account", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "the network offering ID", "length": 255, - "name": "endip", - "required": false, - "type": "string" + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, + "type": "uuid" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "netmask", + "name": "displaynetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "network domain", "length": 255, - "name": "routeripv6", + "name": "networkdomain", "required": false, - "since": "4.16", "type": "string" }, { - "description": "an optional project for the network", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "projectid", - "related": "", + "name": "isolatedpvlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Network ACL ID associated for the network", + "description": "the first IPv4 DNS for the network", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "dns1", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", + "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", "length": 255, - "name": "tungstenvirtualrouteruuid", + "name": "subdomainaccess", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "sourcenatipaddress", + "name": "ip6cidr", "required": false, - "since": "4.19", "type": "string" }, { - "description": "the physical network ID the network belongs to", + "description": "the second IPv4 DNS for the network", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "dns2", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "Ids of the Bgp Peer for the network", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "bgppeerids", - "related": "", + "name": "gateway", "required": false, - "since": "4.20.0", - "type": "list" + "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "the first IPv6 DNS for the network", "length": 255, - "name": "ip6gateway", + "name": "ip6dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the beginning IP address in the network IP range", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "startip", + "name": "netmask", "required": false, "type": "string" }, { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "description": "Network ACL ID associated for the network", "length": 255, - "name": "subdomainaccess", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", "length": 255, - "name": "routerip", + "name": "acltype", "required": false, - "since": "4.16", "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "the display text of the network", "length": 255, - "name": "hideipaddressusage", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "Tungsten-Fabric virtual router the network belongs to", "length": 255, - "name": "gateway", + "name": "tungstenvirtualrouteruuid", "required": false, "type": "string" }, { - "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", + "description": "the AS Number of the network", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "asnumber", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "long" }, { - "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", + "description": "the second IPv6 DNS for the network", "length": 255, - "name": "cidrsize", + "name": "ip6dns2", "required": false, - "since": "4.20.0", - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "the isolated private VLAN for this network", + "description": "ID of the network in an external system.", "length": 255, - "name": "isolatedpvlan", + "name": "externalid", "required": false, "type": "string" }, @@ -128964,18 +140364,26 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "displaynetwork", + "name": "endipv6", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "network domain", + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", "length": 255, - "name": "networkdomain", + "name": "cidrsize", "required": false, - "type": "string" + "since": "4.20.0", + "type": "integer" + }, + { + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "length": 255, + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" }, { "description": "the beginning IPv6 address in the IPv6 network range", @@ -128985,23 +140393,24 @@ "type": "string" }, { - "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", + "description": "an optional project for the network", "length": 255, - "name": "acltype", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the display text of the network", + "description": "the isolated private VLAN type for this network", "length": 255, - "name": "displaytext", + "name": "isolatedpvlantype", "required": false, "type": "string" }, { - "description": "the isolated private VLAN type for this network", + "description": "Account that will own the network. Account should be under the selected domain", "length": 255, - "name": "isolatedpvlantype", + "name": "account", "required": false, "type": "string" }, @@ -129013,79 +140422,80 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the network", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "ip6dns2", + "name": "endip", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "ID of the network in an external system.", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "externalid", + "name": "hideipaddressusage", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "description": "the physical network ID the network belongs to", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the network offering ID", + "description": "the ID or VID of the network", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" + "name": "vlan", + "required": false, + "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "Ids of the Bgp Peer for the network", "length": 255, - "name": "publicmtu", + "name": "bgppeerids", + "related": "", + "required": false, + "since": "4.20.0", + "type": "list" + }, + { + "description": "MTU to be configured on the network VR's private interface(s)", + "length": 255, + "name": "privatemtu", "required": false, "since": "4.18.0", "type": "integer" }, { - "description": "the ID or VID of the network", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "vlan", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "the second IPv4 DNS for the network", + "description": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "dns2", + "name": "routeripv6", "required": false, - "since": "4.18.0", + "since": "4.16", + "type": "string" + }, + { + "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { @@ -129093,124 +140503,14 @@ "name": "displaytext", "type": "string" }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", - "type": "string" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "availability of the network offering the network is created from", "name": "networkofferingavailability", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { @@ -129218,33 +140518,33 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -129253,256 +140553,267 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the name of the network", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, - {}, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, - {}, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -129511,8 +140822,8 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -129521,87 +140832,191 @@ "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", + "description": "the provider name", "name": "name", "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, { "description": "true if network is default, false otherwise", "name": "isdefault", "type": "boolean" }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, { "description": "the owner of the network", "name": "account", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, + {}, { - "description": "related to what other network configuration", - "name": "related", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" } ] }, @@ -129610,6 +141025,13 @@ "isasync": false, "name": "listNetworkOfferings", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list network offerings available for network creation in specific domain", "length": 255, @@ -129620,95 +141042,96 @@ "type": "uuid" }, { - "description": "list network offerings by ID", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "availability", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "pagesize", + "name": "specifyipranges", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "list network offerings by display text", "length": 255, - "name": "isdefault", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "description": "list network offerings by ID", + "length": 255, + "name": "id", + "related": "listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list network offerings by guest type: shared or isolated", + "description": "list network offerings by state", "length": 255, - "name": "guestiptype", + "name": "state", "required": false, "type": "string" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "list network offerings available for network creation in specific zone", "length": 255, - "name": "specifyipranges", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the availability of network offering. Default value is required", + "description": "true if offering has tags specified", "length": 255, - "name": "availability", + "name": "istagged", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list network offerings by display text", - "length": 255, - "name": "displaytext", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "list by traffic type", + "description": "the tags for the network offering.", "length": 255, - "name": "traffictype", + "name": "specifyvlan", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "page", + "name": "sourcenatsupported", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list network offerings by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "true if offering has tags specified", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "istagged", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "list network offerings available for network creation in specific zone", + "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, @@ -129720,45 +141143,37 @@ "type": "string" }, { - "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "list network offerings supporting certain services", + "description": "list by traffic type", "length": 255, - "name": "supportedservices", + "name": "traffictype", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "list network offerings by guest type: shared or isolated", "length": 255, - "name": "sourcenatsupported", + "name": "guestiptype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the network offering can be used only for network creation inside the VPC", + "description": "", "length": 255, - "name": "forvpc", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "list network offerings supporting certain services", "length": 255, - "name": "keyword", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "the tags for the network offering.", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "specifyvlan", + "name": "isdefault", "required": false, "type": "boolean" }, @@ -129774,54 +141189,45 @@ "related": "", "response": [ { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the name of the network offering", - "name": "name", - "type": "string" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, + {}, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", @@ -129829,13 +141235,13 @@ "type": "string" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" }, { - "description": "true if network offering can be used by NSX networks only", - "name": "fornsx", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", "type": "boolean" }, { @@ -129844,139 +141250,117 @@ "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, - {}, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportsinternallb", - "type": "boolean" + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, - {}, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { "description": "uuid of the network provider", "name": "id", "type": "string" }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -129986,9 +141370,9 @@ "name": "capability", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the capability name", + "name": "name", + "type": "string" }, { "description": "the capability value", @@ -129996,39 +141380,70 @@ "type": "string" }, { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" + }, + { + "description": "the name of the network offering", + "name": "name", "type": "string" }, + {}, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + { + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the id of the network offering", - "name": "id", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" } ] @@ -130038,14 +141453,6 @@ "isasync": false, "name": "listDedicatedPods", "params": [ - { - "description": "the ID of the domain associated with the pod", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "the name of the account associated with the pod. Must be used with domainId.", "length": 255, @@ -130062,11 +141469,11 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the pod", @@ -130077,11 +141484,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -130089,11 +141496,23 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "the ID of the domain associated with the pod", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, + { + "description": "the Name of the Pod", + "name": "podname", + "type": "string" + }, {}, { "description": "the ID of the dedicated resource", @@ -130101,23 +141520,18 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Name of the Pod", - "name": "podname", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, { - "description": "the ID of the Pod", - "name": "podid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { @@ -130126,13 +141540,14 @@ "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the ID of the Pod", + "name": "podid", "type": "string" } ] @@ -130143,129 +141558,129 @@ "name": "listVPCs", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list VPCs by state", + "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.", "length": 255, - "name": "state", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list VPC supporting certain services", "length": 255, - "name": "account", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "list VPCs by restartRequired option", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "restartrequired", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "list VPC by id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "isrecursive", + "name": "restartrequired", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list VPC by id", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "List by display text of the VPC", + "description": "list by ID of the VPC offering", "length": 255, - "name": "displaytext", + "name": "vpcofferingid", + "related": "updateVPCOffering", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "keyword", + "name": "cidr", "required": false, "type": "string" }, { - "description": "list by zone", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "list VPCs by state", "length": 255, - "name": "cidr", + "name": "state", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "list by ID of the VPC offering", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "flag to display the resource icon for VPCs", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "showicon", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "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.", + "description": "list by zone", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list VPC supporting certain services", + "description": "", "length": 255, - "name": "supportedservices", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { "description": "list by name of the VPC", @@ -130275,168 +141690,131 @@ "type": "string" }, { - "description": "", + "description": "List by display text of the VPC", "length": 255, - "name": "page", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createVPC,listVPCs,updateVPC", "response": [ { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the VPC", - "name": "name", - "type": "string" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the id of the VPC", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, { "description": "The IPv4 routing mode of VPC", @@ -130444,60 +141822,44 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" + }, + {}, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" }, { "description": "the list of supported services", "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the capability name", + "description": "the provider name", "name": "name", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, { "description": "state of the network provider", "name": "state", @@ -130509,12 +141871,34 @@ "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the provider name", + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", "name": "name", "type": "string" } @@ -130525,35 +141909,29 @@ "type": "list" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, - {}, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", + "description": "The BGP peers for the VPC", + "name": "bgppeers", "type": "set" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the id of the VPC", + "name": "id", + "type": "string" }, { "description": "the owner of the VPC", @@ -130561,66 +141939,103 @@ "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, + {}, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" - }, - { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ] }, { @@ -130629,27 +142044,22 @@ "name": "addNetworkDevice", "params": [ { - "description": "parameters for network device", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "networkdeviceparameterlist", + "name": "networkdevicetype", "required": false, - "type": "map" + "type": "string" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "parameters for network device", "length": 255, - "name": "networkdevicetype", + "name": "networkdeviceparameterlist", "required": false, - "type": "string" + "type": "map" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the ID of the network device", "name": "id", @@ -130661,6 +142071,11 @@ "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -130669,13 +142084,6 @@ "isasync": true, "name": "runDiagnostics", "params": [ - { - "description": "The IP/Domain address to test connection to", - "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" - }, { "description": "The ID of the system VM instance to diagnose", "length": 255, @@ -130697,22 +142105,27 @@ "name": "type", "required": true, "type": "string" + }, + { + "description": "The IP/Domain address to test connection to", + "length": 255, + "name": "ipaddress", + "required": true, + "type": "string" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the standard output from the command execution", "name": "stdout", @@ -130723,6 +142136,8 @@ "name": "exitcode", "type": "string" }, + {}, + {}, { "description": "the standard error output from the command execution", "name": "stderr", @@ -130744,11 +142159,10 @@ "type": "boolean" }, { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "If cleanup old network elements", "length": 255, - "name": "livepatch", + "name": "cleanup", "required": false, - "since": "4.17.0", "type": "boolean" }, { @@ -130760,18 +142174,19 @@ "type": "uuid" }, { - "description": "If cleanup old network elements", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "cleanup", + "name": "livepatch", "required": false, + "since": "4.17.0", "type": "boolean" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -130779,16 +142194,16 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -130798,18 +142213,18 @@ "name": "quotaConfigureEmail", "params": [ { - "description": "If the quota email template should be enabled", + "description": "Quota email template name which should be configured", "length": 255, - "name": "enable", + "name": "templatename", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Quota email template name which should be configured", + "description": "If the quota email template should be enabled", "length": 255, - "name": "templatename", + "name": "enable", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Account ID for which to configure quota template email or min balance", @@ -130829,37 +142244,37 @@ ], "related": "", "response": [ - { - "description": "The template's name.", - "name": "templatename", - "type": "string" - }, - { - "description": "Whether the template is enabled.", - "name": "enabled", - "type": "boolean" - }, { "description": "The configured account's min balance.", "name": "minbalance", "type": "double" }, - { - "description": "The configured account's id.", - "name": "account", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "The configured account's id.", + "name": "account", + "type": "string" + }, + { + "description": "The template's name.", + "name": "templatename", + "type": "string" + }, + { + "description": "Whether the template is enabled.", + "name": "enabled", + "type": "boolean" } ], "since": "4.20.0.0" @@ -130870,9 +142285,9 @@ "name": "addBaremetalDhcp", "params": [ { - "description": "Credentials to reach external dhcp device", + "description": "Type of dhcp device", "length": 255, - "name": "password", + "name": "dhcpservertype", "required": true, "type": "string" }, @@ -130891,39 +142306,28 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Type of dhcp device", + "description": "the Physical Network ID", "length": 255, - "name": "dhcpservertype", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listBaremetalDhcp", "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "name of the provider", - "name": "dhcpservertype", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -130934,16 +142338,27 @@ "name": "id", "type": "string" }, + { + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "url", "name": "url", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, + {}, {} ] }, @@ -130969,28 +142384,28 @@ } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -130998,14 +142413,6 @@ "isasync": true, "name": "copySnapshot", "params": [ - { - "description": "the ID of the snapshot.", - "length": 255, - "name": "id", - "related": "copySnapshot,listSnapshots", - "required": true, - "type": "uuid" - }, { "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.", "length": 255, @@ -131022,6 +142429,31 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the snapshot.", + "length": 255, + "name": "id", + "related": "copySnapshot,listSnapshots", + "required": true, + "type": "uuid" + }, + { + "description": "This parameter enables the option the snapshot to be copied to supported primary storage", + "length": 255, + "name": "usestoragereplication", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "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", + "length": 255, + "name": "storageids", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.21.0", + "type": "list" + }, { "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.", "length": 255, @@ -131034,65 +142466,134 @@ "related": "listSnapshots", "response": [ { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true", + "name": "chainsize", + "type": "long" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, + {}, { - "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", - "name": "state", - "type": "state" + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, + {}, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", "name": "revertable", "type": "boolean" }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, { "description": "virtual size of backedup snapshot on image store", "name": "virtualsize", @@ -131104,162 +142605,98 @@ "type": "date" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "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", + "name": "state", + "type": "state" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, - {}, { - "description": "name of the snapshot", - "name": "name", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, - {}, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, { "description": "type of the datastore for the snapshot entry", "name": "datastoretype", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" } ], @@ -131271,47 +142708,40 @@ "name": "addTrafficMonitor", "params": [ { - "description": "Traffic going into the listed zones will be metered", + "description": "Traffic going into the listed zones will not be metered", "length": 255, - "name": "includezones", + "name": "excludezones", "required": false, "type": "string" }, { - "description": "Zone in which to add the external firewall appliance.", + "description": "URL of the traffic monitor Host", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Traffic going into the listed zones will not be metered", + "description": "Traffic going into the listed zones will be metered", "length": 255, - "name": "excludezones", + "name": "includezones", "required": false, "type": "string" }, { - "description": "URL of the traffic monitor Host", + "description": "Zone in which to add the external firewall appliance.", "length": 255, - "name": "url", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - {}, - {}, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -131319,25 +142749,32 @@ "name": "numretries", "type": "string" }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { "description": "the ID of the external firewall", "name": "id", "type": "string" + }, + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + }, + {}, + { + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" } ] }, @@ -131347,30 +142784,23 @@ "name": "listUsers", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List users by state of the user account.", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "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.", + "description": "flag to display the resource icon for users", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, @@ -131382,26 +142812,35 @@ "type": "string" }, { - "description": "flag to display the resource icon for users", + "description": "List users by the Api key access value", "length": 255, - "name": "showicon", + "name": "apikeyaccess", "required": false, - "type": "boolean" + "since": "4.20.1.0", + "type": "string" }, { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "List user by ID.", "length": 255, - "name": "accounttype", + "name": "id", + "related": "disableUser,getUser,listUsers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List users by state of the user account.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "state", + "name": "account", "required": false, "type": "string" }, + { + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -131410,48 +142849,49 @@ "type": "integer" }, { - "description": "List user by ID.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "disableUser,getUser,listUsers", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "List user by the username", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "username", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List users by the Api key access value", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "apikeyaccess", + "name": "isrecursive", "required": false, - "since": "4.20.1.0", + "type": "boolean" + }, + { + "description": "List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.", + "length": 255, + "name": "usersource", + "required": false, + "since": "4.21.0.0", "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "List user by the username", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "username", "required": false, - "type": "uuid" + "type": "string" } ], "related": "disableUser,getUser", "response": [ { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the user name", @@ -131459,28 +142899,33 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, { "description": "the secret key of the user", "name": "secretkey", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, {}, @@ -131490,44 +142935,49 @@ "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { "description": "the domain ID of the user", @@ -131535,24 +142985,24 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { "description": "the account type of the user", @@ -131561,24 +143011,19 @@ }, {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account name of the user", - "name": "account", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" } ] }, @@ -131594,13 +143039,6 @@ "required": false, "type": "string" }, - { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, - "type": "string" - }, { "description": "the gateway of the IPv6 network", "length": 255, @@ -131609,26 +143047,19 @@ "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "startip", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the gateway of the VLAN IP range", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "gateway", + "name": "endip", "required": false, "type": "string" }, - { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" - }, { "description": "the UUID of the VLAN IP range", "length": 255, @@ -131652,9 +143083,23 @@ "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "endip", + "name": "gateway", + "required": false, + "type": "string" + }, + { + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, + "type": "string" + }, + { + "description": "the beginning IP address in the VLAN IP range", + "length": 255, + "name": "startip", "required": false, "type": "string" } @@ -131662,147 +143107,147 @@ "related": "", "response": [ { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, - {}, { - "description": "indicates whether IP range is dedicated to NSX resources or not", - "name": "fornsx", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, + {}, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, + {}, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + } ], "since": "4.16.0" }, @@ -131812,54 +143257,54 @@ "name": "listResourceLimits", "params": [ { - "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "resourcetype", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "Lists resource limits by ID.", + "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.", "length": 255, - "name": "id", + "name": "listall", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Tag for the resource type", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tag", + "name": "account", "required": false, - "since": "4.20.0", "type": "string" }, { @@ -131870,75 +143315,67 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Tag for the resource type", "length": 255, - "name": "projectid", - "related": "", + "name": "tag", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { - "description": "List by keyword", + "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "keyword", + "name": "resourcetype", "required": false, - "type": "string" + "type": "integer" }, { - "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.", + "description": "Lists resource limits by ID.", "length": 255, - "name": "listall", + "name": "id", "required": false, - "type": "boolean" + "type": "long" } ], "related": "", "response": [ { - "description": "the account of the resource limit", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { - "description": "path of the domain to which the resource limit belongs", - "name": "domainpath", + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", "type": "string" }, { @@ -131946,23 +143383,31 @@ "name": "max", "type": "long" }, + { + "description": "the domain ID of the resource limit", + "name": "domainid", + "type": "string" + }, { "description": "the project id of the resource limit", "name": "projectid", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The tag for the resource limit", - "name": "tag", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, - {}, - {} + { + "description": "the domain name of the resource limit", + "name": "domain", + "type": "string" + } ] }, { @@ -131982,45 +143427,38 @@ "related": "getUser", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user name", + "name": "username", + "type": "string" }, - {}, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -132029,43 +143467,45 @@ "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user name", - "name": "username", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, + {}, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, + {}, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -132074,9 +143514,14 @@ "type": "boolean" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if user is default, false otherwise", @@ -132084,39 +143529,39 @@ "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" } ] }, @@ -132126,59 +143571,41 @@ "name": "listIsos", "params": [ { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "ID of the image or image cache store", + "description": "the ID of the OS category for the ISO", "length": 255, - "name": "imagestoreid", - "related": "listSwifts", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "since": "4.19", + "since": "4.21.0", "type": "uuid" }, { - "description": "If set to true, list only unique isos across zones", + "description": "list ISOs that are ready to be deployed", "length": 255, - "name": "showunique", + "name": "isready", "required": false, - "since": "4.13.2", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "ID of the storage pool", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "hypervisor", "required": false, - "since": "4.19", - "type": "uuid" + "type": "string" }, { - "description": "list all ISOs by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "flag to display the resource image for the isos", + "description": "", "length": 255, - "name": "showicon", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -132188,10 +143615,10 @@ "type": "boolean" }, { - "description": "the ID of the zone", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -132204,159 +143631,131 @@ "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "ID of the image or image cache store", "length": 255, - "name": "hypervisor", + "name": "imagestoreid", + "related": "listSwifts", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "page", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20", + "type": "string" }, { - "description": "", + "description": "the ID of the zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "ispublic", + "name": "showunique", "required": false, + "since": "4.13.2", "type": "boolean" }, { - "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", + "description": "ID of the storage pool", "length": 255, - "name": "arch", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "since": "4.20", - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "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 VM. * 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 a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isofilter", + "name": "account", "required": false, "type": "string" }, { - "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.", + "description": "show removed ISOs as well", "length": 255, - "name": "listall", + "name": "showremoved", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "list ISO by ID", "length": 255, "name": "id", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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 VM. * 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 a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", "length": 255, - "name": "account", + "name": "isofilter", "required": false, "type": "string" }, { - "description": "show removed ISOs as well", + "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.", "length": 255, - "name": "showremoved", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "bootable", + "name": "showicon", "required": false, "type": "boolean" }, - { - "description": "true if this ISO is ready to be deployed", - "length": 255, - "name": "isready", - "required": false, - "type": "boolean" - } - ], - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ { "description": "true if the ISO is bootable, false otherwise", + "length": 255, "name": "bootable", + "required": false, "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "list all ISOs by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the ISO is publicly available to all users, false otherwise.", + "length": 255, + "name": "ispublic", + "required": false, "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template name", + "name": "name", "type": "string" }, { @@ -132364,145 +143763,68 @@ "name": "ostypename", "type": "string" }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "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", - "name": "userdataparams", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the project id of the template", "name": "projectid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - {}, - { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, { "description": "checksum of the template", "name": "checksum", "type": "string" }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -132511,67 +143833,133 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, { "description": "true if this template is a public template, false otherwise", "name": "ispublic", "type": "boolean" }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the template ID", - "name": "id", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { "description": "the id of userdata linked to this template", @@ -132579,24 +143967,79 @@ "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" }, { "description": "the tag of this template", @@ -132604,18 +144047,23 @@ "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { @@ -132624,8 +144072,19 @@ "type": "imageformat" }, { - "description": "the template name", - "name": "name", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { @@ -132634,9 +144093,20 @@ "type": "map" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + {}, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "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", + "name": "userdataparams", + "type": "string" } ] }, @@ -132646,41 +144116,41 @@ "name": "listAutoScalePolicies", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the autoscale policy", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "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.", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "listall", + "name": "vmgroupid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -132692,48 +144162,40 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of the autoscale policy", - "length": 255, - "name": "id", - "related": "listAutoScalePolicies", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the condition of the policy", "length": 255, - "name": "projectid", + "name": "conditionid", "related": "", "required": false, "type": "uuid" }, { - "description": "the ID of the condition of the policy", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "conditionid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the ID of the autoscale vm group", + "description": "the name of the autoscale policy", "length": 255, - "name": "vmgroupid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", @@ -132741,44 +144203,52 @@ "name": "action", "required": false, "type": "string" + }, + { + "description": "the ID of the autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the autoscale policy", - "name": "project", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, + {}, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the autoscale policy", + "name": "domain", + "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" }, { @@ -132787,8 +144257,8 @@ "type": "list" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { @@ -132797,24 +144267,24 @@ "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, + {}, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" }, - {}, { "description": "the autoscale policy ID", "name": "id", "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "name of the autoscale policy", + "name": "name", "type": "string" } ] @@ -132825,20 +144295,11 @@ "name": "dedicateIpv4SubnetForZone", "params": [ { - "description": "domain ID of the account owning the IPv4 subnet", + "description": "account who will own the IPv4 subnet", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" - }, - { - "description": "Id of the guest network IPv4 subnet", - "length": 255, - "name": "id", - "related": "dedicateIpv4SubnetForZone", - "required": true, - "type": "uuid" + "type": "string" }, { "description": "project who will own the IPv4 subnet", @@ -132849,18 +144310,27 @@ "type": "uuid" }, { - "description": "account who will own the IPv4 subnet", + "description": "domain ID of the account owning the IPv4 subnet", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "Id of the guest network IPv4 subnet", + "length": 255, + "name": "id", + "related": "dedicateIpv4SubnetForZone", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { @@ -132874,40 +144344,39 @@ "type": "string" }, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", - "type": "string" - }, - { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, {}, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { @@ -132915,47 +144384,65 @@ "name": "projectid", "type": "string" }, + {}, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" } ], "since": "4.20.0" }, { - "description": "List Shared FileSystems", - "isasync": false, - "name": "listSharedFileSystems", + "description": "adds baremetal rack configuration text", + "isasync": true, + "name": "addBaremetalRct", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "http url to baremetal RCT configuration", "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, + "name": "baremetalrcturl", + "required": true, + "type": "object" + } + ], + "related": "", + "response": [ + {}, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "id of rct", + "name": "id", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "url", + "name": "url", "type": "string" }, + {}, { - "description": "", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "List Shared FileSystems", + "isasync": false, + "name": "listSharedFileSystems", + "params": [ + { + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the network", @@ -132966,41 +144453,41 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the availability zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "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.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "isrecursive", + "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, { - "description": "the disk offering of the shared filesystem", + "description": "List by keyword", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -133010,10 +144497,17 @@ "type": "integer" }, { - "description": "the service offering of the shared filesystem", + "description": "the name of the shared filesystem", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the disk offering of the shared filesystem", + "length": 255, + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, @@ -133026,132 +144520,93 @@ "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "the ID of the shared filesystem", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the shared filesystem", + "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.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the shared filesystem", + "description": "the service offering of the shared filesystem", "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" } ], "related": "changeSharedFileSystemDiskOffering", "response": [ { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, - { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, { "description": "the disk utilization", "name": "utilization", "type": "string" }, - { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, + {}, { "description": "name of the storage pool hosting the data volume", "name": "storage", "type": "string" }, - { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" - }, - { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { @@ -133160,74 +144615,24 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "name": "adaptertype", + "type": "string" }, { "description": "the isolated private VLAN if available", @@ -133240,8 +144645,13 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -133250,139 +144660,131 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" - } - ], - "type": "list" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", - "type": "string" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], - "type": "set" + "type": "list" }, { - "description": "size of the shared filesystem", - "name": "size", + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, - {}, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "name": "vmstate", + "type": "string" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { @@ -133391,142 +144793,210 @@ "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" }, - {}, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "ID of the storage fs vm", - "name": "vmstate", + "name": "virtualmachineid", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "description": "name of the shared filesystem", + "name": "name", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "adds baremetal rack configuration text", - "isasync": true, - "name": "addBaremetalRct", - "params": [ + }, { - "description": "http url to baremetal RCT configuration", - "length": 255, - "name": "baremetalrcturl", - "required": true, - "type": "object" - } - ], - "related": "", - "response": [ + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "url", - "name": "url", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "id of rct", - "name": "id", + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" } - ] + ], + "since": "4.20.0" }, { "description": "Updates a role", @@ -133534,16 +145004,16 @@ "name": "updateRole", "params": [ { - "description": "The description of the role", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", "length": 255, - "name": "description", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The description of the role", + "description": "creates a role with this unique name", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" }, @@ -133555,19 +145025,12 @@ "type": "string" }, { - "description": "creates a role with this unique name", + "description": "The description of the role", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, { "description": "ID of the role", "length": 255, @@ -133575,13 +145038,20 @@ "related": "listRoles,updateRole", "required": true, "type": "uuid" + }, + { + "description": "The description of the role", + "length": 255, + "name": "description", + "required": false, + "type": "string" } ], "related": "listRoles", "response": [ { - "description": "the state of the role", - "name": "state", + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -133590,8 +145060,8 @@ "type": "integer" }, { - "description": "the type of the role", - "name": "type", + "description": "the ID of the role", + "name": "id", "type": "string" }, { @@ -133600,32 +145070,32 @@ "type": "boolean" }, { - "description": "the description of the role", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the state of the role", + "name": "state", "type": "string" }, {}, { - "description": "the ID of the role", - "name": "id", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "name", "type": "string" }, + {}, { "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).", "name": "ispublic", "type": "boolean" - }, - {} + } ], "since": "4.9.0" }, @@ -133635,11 +145105,19 @@ "name": "listRemoteAccessVpns", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "public ip address id of the vpn server", "length": 255, - "name": "account", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { "description": "Lists remote access vpn rule with the specified ID", @@ -133650,6 +145128,13 @@ "since": "4.3", "type": "uuid" }, + { + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -133659,28 +145144,26 @@ "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "fordisplay", + "name": "account", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "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.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list remote access VPNs for certain network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "page", "required": false, - "since": "4.3", - "type": "uuid" + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -133691,72 +145174,61 @@ "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "public ip address id of the vpn server", + "description": "list remote access VPNs for certain network", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" } ], "related": "", "response": [ { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, + {}, + {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -133765,40 +145237,38 @@ "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the range of ips to allocate to the clients", + "name": "iprange", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { @@ -133828,22 +145298,22 @@ "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, {} ], "since": "4.20.0" @@ -133863,28 +145333,28 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ] }, { @@ -133902,17 +145372,16 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -133920,10 +145389,11 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { @@ -133931,14 +145401,6 @@ "isasync": true, "name": "createServiceInstance", "params": [ - { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "The right (outside) network ID for the service instance", "length": 255, @@ -133947,6 +145409,13 @@ "required": true, "type": "uuid" }, + { + "description": "The name of the service instance", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Availability zone for the service instance", "length": 255, @@ -133955,6 +145424,14 @@ "required": true, "type": "uuid" }, + { + "description": "The service offering ID that defines the resources consumed by the service appliance", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, { "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, @@ -133962,6 +145439,14 @@ "required": false, "type": "string" }, + { + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "Project ID for the service instance", "length": 255, @@ -133982,84 +145467,69 @@ "description": "The template ID that specifies the image for the service appliance", "length": 255, "name": "templateid", - "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, - { - "description": "The service offering ID that defines the resources consumed by the service appliance", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" - }, - { - "description": "The name of the service instance", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, - {}, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, + {}, { - "description": "path of the Domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the Domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" } ] }, @@ -134080,135 +145550,123 @@ "related": "", "response": [ { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, - {}, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { "description": "the private MAC address for the system VM", "name": "privatemacaddress", "type": "string" }, - {}, - { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" - }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { @@ -134217,85 +145675,87 @@ "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, + {}, { - "description": "the name of the system VM", - "name": "name", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" - } + }, + {} ] }, { @@ -134304,11 +145764,12 @@ "name": "registerVnfTemplate", "params": [ { - "description": "true if this template is a featured template, false otherwise", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "isfeatured", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { "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. ", @@ -134319,56 +145780,72 @@ "type": "list" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "ID of the extension", "length": 255, - "name": "templatetype", + "name": "extensionid", + "related": "listExtensions", "required": false, - "since": "4.19.0", - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "true if this template requires HVM", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "requireshvm", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "ispublic", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" }, { - "description": "the name of the template", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "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 \"{}\", not including the double quotes. In this 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.", "length": 255, - "name": "vnfdetails", + "name": "checksum", "required": false, - "type": "map" + "type": "string" }, { - "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", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "ostypeid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, + { + "description": "if true, the templates would be available for deploying CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "32 or 64 bits support. 64 by default", + "length": 255, + "name": "bits", + "required": false, + "type": "integer" + }, { "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, @@ -134377,57 +145854,69 @@ "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "arch", + "name": "deployasis", "required": false, - "since": "4.20", - "type": "string" + "since": "4.15.1", + "type": "boolean" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "directdownload", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "deployasis", + "name": "sshkeyenabled", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "externaldetails", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "map" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "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", + "length": 255, + "name": "vnfnics", + "required": false, + "type": "map" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "bits", + "name": "isdynamicallyscalable", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" }, { "description": "the target hypervisor for the template", @@ -134437,45 +145926,40 @@ "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "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", "length": 255, - "name": "account", + "name": "ostypeid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "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", + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", "length": 255, - "name": "vnfnics", + "name": "vnfdetails", "required": false, "type": "map" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if this template requires HVM", "length": 255, - "name": "sshkeyenabled", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, - "type": "string" - }, - { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "name": "templatetype", "required": false, + "since": "4.19.0", "type": "string" }, { @@ -134486,11 +145970,12 @@ "type": "boolean" }, { - "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 \"{}\", not including the double quotes. In this 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.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "checksum", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Register template for the project", @@ -134501,70 +145986,153 @@ "type": "uuid" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "isdynamicallyscalable", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the name of the template", "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" } ], - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, + {}, { "description": "the template ID", "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "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", + "name": "userdataparams", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -134572,16 +146140,10 @@ "name": "crossZones", "type": "boolean" }, - {}, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", @@ -134589,272 +146151,211 @@ "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "additional key/value details tied with template", + "name": "details", "type": "map" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "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", - "name": "userdataparams", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, + {}, { - "description": "the size of the template", - "name": "size", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the template name", - "name": "name", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, - {}, { "description": "the type of the template", "name": "templatetype", "type": "string" }, + {}, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" } ], "since": "4.19.0" @@ -134868,7 +146369,7 @@ "description": "the ID of the virtual machine.", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "required": false, "type": "uuid" }, @@ -134880,33 +146381,40 @@ "type": "date" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "startdate", + "name": "pagesize", "required": false, - "type": "date" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "the IDs of the virtual machines, mutually exclusive with id.", "length": 255, "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "required": false, "type": "list" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "name", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "", + "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -134914,33 +146422,11 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "listSystemVmsUsageHistory", "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -134952,10 +146438,25 @@ "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, { "description": "the list of VM stats", "name": "stats", "type": "list" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" } ], "since": "4.17" @@ -134977,29 +146478,14 @@ "related": "reconnectHost", "response": [ { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { "description": "the name of the host", @@ -135007,151 +146493,101 @@ "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, - {}, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "events available for the host", - "name": "events", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, + {}, { "description": "the Pod ID of the host", "name": "podid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -135161,43 +146597,43 @@ "name": "vgpu", "response": [ { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" } ], @@ -135212,79 +146648,134 @@ "type": "list" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { @@ -135293,18 +146784,23 @@ "type": "date" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { @@ -135313,59 +146809,115 @@ "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { "description": "the cluster name of the host", "name": "clustername", "type": "string" }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, { "description": "the Zone ID of the host", "name": "zoneid", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + {}, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.16.0.0" @@ -135376,35 +146928,66 @@ "name": "createKubernetesCluster", "params": [ { - "description": "Deploy cluster for the project", + "description": "name for the Kubernetes cluster", "length": 255, - "name": "projectid", - "related": "", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "root disk size in GB for each node", + "length": 255, + "name": "noderootdisksize", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "size", + "name": "masternodes", "required": false, "type": "long" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "user name for the docker image private registry", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "dockerregistryusername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "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", "length": 255, - "name": "masternodes", + "name": "etcdnodes", "required": false, + "since": "4.21.0", "type": "long" }, + { + "description": "availability zone in which Kubernetes cluster to be launched", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "cniconfigurationid", + "related": "", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template", + "length": 255, + "name": "nodetemplates", + "required": false, + "since": "4.21.0", + "type": "map" + }, { "description": "Kubernetes version with which cluster to be launched", "length": 255, @@ -135414,32 +146997,68 @@ "type": "uuid" }, { - "description": "user name for the docker image private registry", + "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", "length": 255, - "name": "dockerregistryusername", + "name": "cniconfigdetails", + "required": false, + "since": "4.21.0", + "type": "map" + }, + { + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "length": 255, + "name": "externalloadbalanceripaddress", + "required": false, + "type": "string" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "availability zone in which Kubernetes cluster to be launched", + "description": "number of Kubernetes cluster worker nodes", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. Hosts dedicated to the specified domain will be used for deploying the cluster", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the AS Number of the network", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" + }, + { + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "controlnodes", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "externalloadbalanceripaddress", + "name": "keypair", "required": false, "type": "string" }, @@ -135459,27 +147078,21 @@ "type": "string" }, { - "description": "root disk size in GB for each node", + "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", "length": 255, - "name": "noderootdisksize", + "name": "nodeofferings", "required": false, - "type": "long" + "since": "4.21.0", + "type": "map" }, { - "description": "Network in which Kubernetes cluster is to be launched", + "description": "Deploy cluster for the project", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, - { - "description": "URL for the docker image private registry", - "length": 255, - "name": "dockerregistryurl", - "required": false, - "type": "string" - }, { "description": "password for the docker image private registry", "length": 255, @@ -135488,30 +147101,25 @@ "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "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.", "length": 255, - "name": "account", + "name": "hypervisor", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "controlnodes", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "long" - }, - { - "description": "name for the Kubernetes cluster", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "URL for the docker image private registry", "length": 255, - "name": "keypair", + "name": "dockerregistryurl", "required": false, "type": "string" } @@ -135519,65 +147127,74 @@ "related": "startKubernetesCluster", "response": [ { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", + "type": "string" + }, + { + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", + "type": "string" + }, + { + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, - {}, { "description": "the id of the Kubernetes cluster", "name": "id", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", + "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { "description": "Public IP Address ID of the cluster", @@ -135585,9 +147202,9 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" }, { "description": "the name of the domain in which the Kubernetes cluster exists", @@ -135595,33 +147212,49 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, + {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { @@ -135630,85 +147263,110 @@ "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "keypair details", - "name": "keypair", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, - {}, { "description": "the ID of the template of the Kubernetes cluster", "name": "templateid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, + {}, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" } ] }, @@ -135718,12 +147376,11 @@ "name": "listStorageNetworkIpRange", "params": [ { - "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -135733,94 +147390,95 @@ "type": "integer" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "description": "", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createStorageNetworkIpRange", "response": [ { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, + {}, { "description": "the start ip of the storage network IP range", "name": "startip", "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", + "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "3.0.0" @@ -135830,13 +147488,6 @@ "isasync": true, "name": "configureVirtualRouterElement", "params": [ - { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the virtual router provider", "length": 255, @@ -135844,13 +147495,27 @@ "related": "configureVirtualRouterElement", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "", "response": [ + {}, + {}, { - "description": "the account associated with the provider", - "name": "account", + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -135859,24 +147524,23 @@ "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "path of the domain to which the provider belongs", + "name": "domainpath", + "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { @@ -135884,20 +147548,14 @@ "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the router", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -135923,14 +147581,10 @@ ], "related": "disableHAForHost", "response": [ + {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { @@ -135945,20 +147599,24 @@ "type": "boolean" }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { "description": "operation status", "name": "status", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.11" @@ -135968,14 +147626,6 @@ "isasync": true, "name": "updateVMAffinityGroup", "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, { "description": "comma separated list of affinity groups names that are 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", "length": 255, @@ -135984,6 +147634,14 @@ "required": false, "type": "list" }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "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", + "required": true, + "type": "uuid" + }, { "description": "comma separated list of affinity groups id that are 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", "length": 255, @@ -135993,266 +147651,201 @@ "type": "list" } ], - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the security group", + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -136260,18 +147853,13 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -136280,28 +147868,28 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -136310,21 +147898,21 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -136333,8 +147921,8 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -136343,66 +147931,158 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "security group name", @@ -136414,13 +148094,8 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -136428,16 +148103,16 @@ "name": "domain", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", @@ -136449,18 +148124,23 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -136470,31 +148150,46 @@ } ], "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -136503,186 +148198,54 @@ "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { "description": "the number of vCPUs this virtual machine is using", @@ -136690,87 +148253,193 @@ "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + {}, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", "type": "date" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -136783,149 +148452,77 @@ "name": "customer", "type": "string" }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "id of the resource", "name": "resourceid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" }, { - "description": "the project ID of the affinity group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", + "description": "path of the Domain associated with the tag", "name": "domainpath", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the affinity group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" } ], "type": "set" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { @@ -136934,13 +148531,13 @@ "type": "map" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -136948,147 +148545,268 @@ "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, - {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" } ] @@ -137120,27 +148838,27 @@ "name": "name", "type": "string" }, - {}, + { + "description": "Service Package UUID", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Service Package UUID", - "name": "id", + "description": "Description of Service Package", + "name": "description", "type": "string" }, {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "Description of Service Package", - "name": "description", - "type": "string" } ] }, @@ -137150,23 +148868,24 @@ "name": "updateWebhook", "params": [ { - "description": "Name for the Webhook", + "description": "Description for the Webhook", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "Secret key of the Webhook", + "description": "The ID of the Webhook", "length": 255, - "name": "secretkey", - "required": false, - "type": "string" + "name": "id", + "related": "createWebhook", + "required": true, + "type": "uuid" }, { - "description": "Payload URL of the Webhook", + "description": "State of the Webhook", "length": 255, - "name": "payloadurl", + "name": "state", "required": false, "type": "string" }, @@ -137178,48 +148897,35 @@ "type": "string" }, { - "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "description": "Payload URL of the Webhook", "length": 255, - "name": "sslverification", + "name": "payloadurl", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "State of the Webhook", + "description": "Name for the Webhook", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "The ID of the Webhook", + "description": "Secret key of the Webhook", "length": 255, - "name": "id", - "related": "createWebhook", - "required": true, - "type": "uuid" + "name": "secretkey", + "required": false, + "type": "string" }, { - "description": "Description for the Webhook", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "description", + "name": "sslverification", "required": false, - "type": "string" + "type": "boolean" } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -137229,6 +148935,18 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.20.0" @@ -137238,13 +148956,6 @@ "isasync": false, "name": "quotaCredits", "params": [ - { - "description": "Value of the credits to be added+, subtracted-", - "length": 255, - "name": "value", - "required": true, - "type": "double" - }, { "description": "Domain for which quota credits need to be added", "length": 255, @@ -137253,6 +148964,13 @@ "required": true, "type": "uuid" }, + { + "description": "Minimum balance threshold of the account", + "length": 255, + "name": "min_balance", + "required": false, + "type": "double" + }, { "description": "Account for which quota enforce is set to false will not be locked when there is no credit balance", "length": 255, @@ -137260,57 +148978,194 @@ "required": false, "type": "boolean" }, + { + "description": "Value of the credits to be added+, subtracted-", + "length": 255, + "name": "value", + "required": true, + "type": "double" + }, { "description": "Account Id for which quota credits need to be added", "length": 255, "name": "account", "required": true, "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "The credit deposited.", + "name": "credit", + "type": "bigdecimal" + }, + { + "description": "Credit's currency.", + "name": "currency", + "type": "string" }, + {}, { - "description": "Minimum balance threshold of the account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ID of the creditor user.", + "name": "creditoruserid", + "type": "string" + }, + { + "description": "When the credit was added.", + "name": "creditedon", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Username of the creditor user.", + "name": "creditorusername", + "type": "string" + } + ], + "since": "4.7.0" + }, + { + "description": "Discovers available GPU devices on a host", + "isasync": false, + "name": "discoverGpuDevices", + "params": [ + { + "description": "", "length": 255, - "name": "min_balance", + "name": "pagesize", "required": false, - "type": "double" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "ID of the host", + "length": 255, + "name": "id", + "related": "reconnectHost", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "listGpuDevices", "response": [ + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the GPU device", + "name": "id", + "type": "string" + }, + { + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" + }, + { + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" + }, + {}, {}, { - "description": "currency", - "name": "currency", + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", "type": "string" }, { - "description": "the account name of the admin who updated the credits", - "name": "updated_on", - "type": "date" + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the NUMA node where the GPU device is located", + "name": "numanode", + "type": "string" + }, + { + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the credit deposited", - "name": "credits", - "type": "bigdecimal" + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" }, { - "description": "the user name of the admin who updated the credits", - "name": "updated_by", - "type": "string" + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" + }, + { + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" } ], - "since": "4.7.0" + "since": "4.21.0" }, { "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", @@ -137328,30 +149183,30 @@ "related": "", "response": [ { - "description": "Private key for the certificate", - "name": "privatekey", + "description": "The client certificate", + "name": "certificate", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" }, + {}, + {}, { - "description": "The client certificate", - "name": "certificate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "Private key for the certificate", + "name": "privatekey", "type": "string" } ], @@ -137381,58 +149236,31 @@ ], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the name of the host", "name": "hostname", "type": "string" }, - { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", - "type": "string" - }, - { - "description": "indicates the details in case of failure or host skipped", - "name": "details", - "type": "string" - }, { "description": "the ID of the host", "name": "hostid", "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "SAML Global Log Out API", - "isasync": false, - "name": "samlSlo", - "params": [], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, - {}, { - "description": "Response description", - "name": "description", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, { @@ -137440,7 +149268,8 @@ "name": "jobstatus", "type": "integer" } - ] + ], + "since": "4.17.0" }, { "description": "Creates a Project role", @@ -137448,10 +149277,10 @@ "name": "updateProjectRole", "params": [ { - "description": "ID of project where role is being created", + "description": "ID of the Project role", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "updateProjectRole", "required": true, "type": "uuid" }, @@ -137463,10 +149292,10 @@ "type": "string" }, { - "description": "ID of the Project role", + "description": "ID of project where role is being created", "length": 255, - "name": "id", - "related": "updateProjectRole", + "name": "projectid", + "related": "", "required": true, "type": "uuid" }, @@ -137480,43 +149309,43 @@ ], "related": "", "response": [ + {}, + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, { "description": "the description of the role", "name": "description", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "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).", "name": "ispublic", "type": "boolean" }, { - "description": "the name of the role", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the id of the project", "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.15.0" }, @@ -137525,6 +149354,13 @@ "isasync": false, "name": "addLdapConfiguration", "params": [ + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, { "description": "linked domain", "length": 255, @@ -137533,13 +149369,6 @@ "required": false, "type": "uuid" }, - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, { "description": "Port", "length": 255, @@ -137551,30 +149380,30 @@ "related": "", "response": [ { - "description": "linked domain", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, + {}, { "description": "name of the host running the ldap server", "name": "hostname", "type": "string" }, { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "linked domain", + "name": "domainid", "type": "string" } ], @@ -137586,16 +149415,16 @@ "name": "createTungstenFabricAddressGroup", "params": [ { - "description": "Tungsten-Fabric ip prefix length", + "description": "Tungsten-Fabric ip prefix", "length": 255, - "name": "ipprefixlen", + "name": "ipprefix", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric ip prefix", + "description": "Tungsten-Fabric address group name", "length": 255, - "name": "ipprefix", + "name": "name", "required": true, "type": "string" }, @@ -137608,18 +149437,19 @@ "type": "uuid" }, { - "description": "Tungsten-Fabric address group name", + "description": "Tungsten-Fabric ip prefix length", "length": 255, - "name": "name", + "name": "ipprefixlen", "required": true, - "type": "string" + "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -137629,13 +149459,8 @@ }, {}, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, { @@ -137648,16 +149473,20 @@ "name": "zonename", "type": "string" }, - { - "description": "Tungsten-Fabric address group name", - "name": "name", - "type": "string" - }, - {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" + }, + { + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", + "type": "string" } ] }, @@ -137666,6 +149495,13 @@ "isasync": false, "name": "listBigSwitchBcfDevices", "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "bigswitch BCF controller device ID", "length": 255, @@ -137675,18 +149511,18 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the Physical Network ID", @@ -137695,20 +149531,14 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { @@ -137716,6 +149546,16 @@ "name": "nat", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "name of the provider", @@ -137723,8 +149563,8 @@ "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { @@ -137732,30 +149572,19 @@ "name": "username", "type": "string" }, - { - "description": "the controller password", - "name": "password", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the physical network to which this BigSwitch BCF segment belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the controller password", + "name": "password", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" } ], @@ -137766,13 +149595,6 @@ "isasync": false, "name": "listRegisteredServicePackages", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -137786,18 +149608,21 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Service Package UUID", - "name": "id", + "description": "Service Package Name", + "name": "name", "type": "string" }, { @@ -137806,8 +149631,8 @@ "type": "integer" }, { - "description": "Service Package Name", - "name": "name", + "description": "Service Package UUID", + "name": "id", "type": "string" }, { @@ -137816,7 +149641,11 @@ "type": "string" }, {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -137825,17 +149654,16 @@ "name": "changeSharedFileSystemDiskOffering", "params": [ { - "description": "the ID of the shared filesystem", + "description": "min iops", "length": 255, - "name": "id", - "related": "changeSharedFileSystemDiskOffering", - "required": true, - "type": "uuid" + "name": "miniops", + "required": false, + "type": "long" }, { - "description": "min iops", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "miniops", + "name": "size", "required": false, "type": "long" }, @@ -137848,16 +149676,17 @@ "type": "uuid" }, { - "description": "max iops", + "description": "the ID of the shared filesystem", "length": 255, - "name": "maxiops", - "required": false, - "type": "long" + "name": "id", + "related": "changeSharedFileSystemDiskOffering", + "required": true, + "type": "uuid" }, { - "description": "the size of the shared filesystem in GiB", + "description": "max iops", "length": 255, - "name": "size", + "name": "maxiops", "required": false, "type": "long" } @@ -137865,68 +149694,8 @@ "related": "", "response": [ { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the storage fs data volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "description of the shared filesystem", - "name": "description", - "type": "string" - }, - { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", - "type": "string" - }, - { - "description": "the domain associated with the shared filesystem", - "name": "domain", - "type": "string" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { @@ -137935,112 +149704,114 @@ "type": "string" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -138049,10 +149820,15 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", "name": "nsxlogicalswitch", @@ -138060,159 +149836,146 @@ }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - {}, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, - { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" - }, {}, { "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "name": "vmstate", "type": "string" }, { @@ -138221,13 +149984,28 @@ "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { @@ -138236,13 +150014,18 @@ "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { @@ -138251,19 +150034,19 @@ "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -138271,33 +150054,79 @@ "type": "integer" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", "type": "boolean" }, + { + "description": "the filesystem format", + "name": "filesystem", + "type": "string" + }, { "description": "the write (IO) of disk on the shared filesystem", "name": "diskiowrite", "type": "long" }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, { "description": "the bytes allocated", "name": "virtualsize", "type": "long" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" } ], @@ -138312,15 +150141,7 @@ "description": "the ID of the virtual machine for enabling static NAT feature", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "the public IP address ID for which static NAT feature is being enabled", - "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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", "required": true, "type": "uuid" }, @@ -138338,18 +150159,22 @@ "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" + }, + { + "description": "the public IP address ID for which static NAT feature is being enabled", + "length": 255, + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" } ], "response": [ + {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -138357,10 +150182,14 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -138380,27 +150209,27 @@ } ], "response": [ + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -138419,28 +150248,28 @@ } ], "response": [ - {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ], "since": "4.20.0" }, @@ -138450,33 +150279,34 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isrouting", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the volume/template/iso", + "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.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "32 or 64 bits support. 64 by default", - "length": 255, - "name": "bits", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { "description": "true if the template supports the sshkey upload feature; default is false", @@ -138486,11 +150316,11 @@ "type": "boolean" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "format", - "required": true, - "type": "string" + "name": "ispublic", + "required": false, + "type": "boolean" }, { "description": "Template details in key/value pairs.", @@ -138500,30 +150330,31 @@ "type": "map" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "if true, the templates would be available for deploying CKS clusters", "length": 255, - "name": "account", + "name": "forcks", "required": false, - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "the name of the volume/template/iso", "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the tag for this template.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "templatetag", + "name": "account", "required": false, "type": "string" }, @@ -138536,56 +150367,55 @@ "type": "boolean" }, { - "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 \"{}\", not including the double quotes. In this 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.", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "checksum", + "name": "isrouting", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "isfeatured", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "arch", - "required": false, - "since": "4.20", - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "true if this template requires HVM", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "requireshvm", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "bits", + "required": false, + "type": "integer" }, { - "description": "Upload volume/template/iso for the project", + "description": "the tag for this template.", "length": 255, - "name": "projectid", - "related": "", + "name": "templatetag", "required": false, - "type": "uuid" + "type": "string" }, { - "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.", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "ostypeid", - "related": "", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20", + "type": "string" }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", @@ -138595,26 +150425,33 @@ "type": "boolean" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the target hypervisor for the template", "length": 255, - "name": "passwordenabled", + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "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 \"{}\", not including the double quotes. In this 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.", + "length": 255, + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "format", + "required": true, + "type": "string" } ], "related": "getUploadParamsForIso", @@ -138624,30 +150461,72 @@ "name": "id", "type": "uuid" }, - {}, { "description": "encrypted data to be sent in the POST request.", "name": "metadata", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, + {}, + {}, { "description": "POST url to upload the file to", "name": "postURL", "type": "url" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.6.0" + }, + { + "description": "Deletes snapshot policies for the account.", + "isasync": false, + "name": "deleteSnapshotPolicies", + "params": [ + { + "description": "list of snapshots policy IDs separated by comma", + "length": 255, + "name": "ids", + "related": "updateSnapshotPolicy", + "required": false, + "type": "list" + }, + { + "description": "the Id of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -138655,56 +150534,85 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, {} - ], - "since": "4.6.0" + ] }, { - "description": "Deletes snapshot policies for the account.", + "description": "delete Netris Provider to CloudStack", "isasync": false, - "name": "deleteSnapshotPolicies", + "name": "deleteNetrisProvider", "params": [ { - "description": "the Id of the snapshot policy", + "description": "Netris Provider ID", "length": 255, "name": "id", - "related": "updateSnapshotPolicy", - "required": false, + "related": "deleteNetrisProvider", + "required": true, "type": "uuid" - }, - { - "description": "list of snapshots policy IDs separated by comma", - "length": 255, - "name": "ids", - "related": "updateSnapshotPolicy", - "required": false, - "type": "list" } ], + "related": "", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Netris Tag for vNets", + "name": "netristag", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Netris Provider URL", + "name": "netrisurl", + "type": "string" + }, + { + "description": "Netris Provider site", + "name": "sitename", + "type": "string" + }, + { + "description": "Netris provider uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Netris Admin tenant name", + "name": "tenantname", + "type": "string" + }, + { + "description": "Netris Provider name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", + "type": "string" } - ] + ], + "since": "4.21.0" }, { "description": "Lists implementors of implementor of a network traffic type or implementors of all network traffic types", @@ -138712,18 +150620,18 @@ "name": "listTrafficTypeImplementors", "params": [ { - "description": "List by keyword", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", "length": 255, - "name": "keyword", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -138733,18 +150641,23 @@ "type": "integer" }, { - "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", + "description": "", "length": 255, - "name": "traffictype", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "network traffic type", - "name": "traffictype", + "description": "implementor of network traffic type", + "name": "traffictypeimplementor", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -138753,17 +150666,12 @@ "type": "integer" }, { - "description": "implementor of network traffic type", - "name": "traffictypeimplementor", + "description": "network traffic type", + "name": "traffictype", "type": "string" }, {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -138775,19 +150683,19 @@ "related": "", "response": [ { - "description": "the name of the active usage server", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "the uptime of the DB in seconds", - "name": "uptime", - "type": "long" + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" }, { "description": "the version of the currently running DB", @@ -138795,8 +150703,13 @@ "type": "string" }, { - "description": "the number of queries performed on the DB", - "name": "queries", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the uptime of the DB in seconds", + "name": "uptime", "type": "long" }, { @@ -138805,37 +150718,32 @@ "type": "double[]" }, { - "description": "the version of the currently running DB", - "name": "version", + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, - {}, - { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" - }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the version of the currently running DB", + "name": "version", + "type": "string" }, { "description": "the number of connections to the DB", "name": "connections", "type": "int" }, - {}, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the number of queries performed on the DB", + "name": "queries", + "type": "long" }, { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", - "type": "string" - } + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" + }, + {}, + {} ], "since": "4.17.0" }, @@ -138854,27 +150762,27 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ], "since": "4.2.0" @@ -138885,25 +150793,26 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "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.", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listAutoScaleVmProfiles", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the otherdeployparameters of the autoscale vm profile", + "description": "", "length": 255, - "name": "otherdeployparams", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -138916,32 +150825,40 @@ "description": "the templateid of the autoscale vm profile", "length": 255, "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "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.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -138952,27 +150869,25 @@ "type": "boolean" }, { - "description": "the ID of the autoscale vm profile", + "description": "", "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "isrecursive", + "name": "otherdeployparams", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, - "since": "4.4", "type": "uuid" }, { @@ -138983,35 +150898,18 @@ "required": false, "since": "4.4", "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { @@ -139020,73 +150918,73 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Base64 encoded VM user data", + "name": "userdata", + "type": "string" }, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, + {}, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, {}, - {}, - {}, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, {}, { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", + "type": "string" }, { "description": "the domain name of the vm profile", @@ -139094,14 +150992,24 @@ "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" + }, + { + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, @@ -139111,11 +151019,11 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "user to security group mapping", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", "length": 255, - "name": "usersecuritygrouplist", + "name": "protocol", "required": false, - "type": "map" + "type": "string" }, { "description": "error code for this icmp message", @@ -139124,20 +151032,6 @@ "required": false, "type": "integer" }, - { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "start port for this ingress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, { "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, @@ -139147,33 +151041,33 @@ "type": "uuid" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "protocol", + "name": "securitygroupname", "required": false, "type": "string" }, { - "description": "an optional project of the security group", + "description": "user to security group mapping", "length": 255, - "name": "projectid", - "related": "", + "name": "usersecuritygrouplist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "cidrlist", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "an optional project of the security group", "length": 255, - "name": "securitygroupname", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "type of the icmp message being sent", @@ -139196,40 +151090,38 @@ "name": "endport", "required": false, "type": "integer" - } - ], - "related": "", - "response": [ + }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "start port for this ingress rule", + "length": 255, + "name": "startport", + "required": false, "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - {}, + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + } + ], + "related": "", + "response": [ { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the starting IP of the security group rule", @@ -139237,42 +151129,43 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -139281,44 +151174,59 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - {} + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + {}, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } ] }, { @@ -139338,28 +151246,28 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { @@ -139368,19 +151276,29 @@ "type": "date" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -139388,34 +151306,41 @@ "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the hypervisor type of the storage pool", "name": "hypervisor", "type": "string" }, + {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { "description": "the storage pool type", @@ -139423,19 +151348,19 @@ "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { "description": "the overprovisionfactor for the storage pool", @@ -139443,66 +151368,59 @@ "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, - {}, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, - {}, { - "description": "the storage pool path", - "name": "path", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" } ], "since": "4.15.1" @@ -139512,13 +151430,6 @@ "isasync": false, "name": "updateBucket", "params": [ - { - "description": "Bucket Quota in GB", - "length": 255, - "name": "quota", - "required": false, - "type": "integer" - }, { "description": "Enable/Disable Bucket encryption", "length": 255, @@ -139541,6 +151452,13 @@ "required": true, "type": "uuid" }, + { + "description": "Bucket Quota in GiB", + "length": 255, + "name": "quota", + "required": false, + "type": "integer" + }, { "description": "Enable/Disable Bucket Versioning", "length": 255, @@ -139550,28 +151468,28 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.19.0" }, @@ -139580,6 +151498,21 @@ "isasync": false, "name": "updateResourceCount", "params": [ + { + "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "name": "resourcetype", + "required": false, + "type": "integer" + }, + { + "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": true, + "type": "uuid" + }, { "description": "Tag for the resource type", "length": 255, @@ -139602,28 +151535,13 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": true, - "type": "uuid" - }, - { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, { @@ -139631,21 +151549,16 @@ "name": "project", "type": "string" }, - {}, { - "description": "the project id for which resource count's are updated", - "name": "projectid", + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", - "type": "string" + "description": "The resource count", + "name": "resourcecount", + "type": "long" }, { "description": "path of the domain to which the resource counts are updated", @@ -139653,35 +151566,40 @@ "type": "string" }, { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the account for which resource count's are updated", - "name": "account", + "description": "the project id for which resource count's are updated", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name for which resource count's are updated", + "name": "domain", "type": "string" }, - { - "description": "The resource count", - "name": "resourcecount", - "type": "long" - }, { "description": "Tag for the resource", "name": "tag", "type": "string" + }, + { + "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain ID for which resource count's are updated", + "name": "domainid", + "type": "string" } ] }, @@ -139698,9 +151616,9 @@ "type": "string" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "List role by role type status, valid options are: enabled, disabled", "length": 255, - "name": "type", + "name": "state", "required": false, "type": "string" }, @@ -139712,69 +151630,52 @@ "type": "string" }, { - "description": "List role by role ID.", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "id", - "related": "listRoles", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List role by role type status, valid options are: enabled, disabled", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List role by role ID.", "length": 255, - "name": "page", + "name": "id", + "related": "listRoles", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "", "response": [ - { - "description": "the description of the role", - "name": "description", - "type": "string" - }, { "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).", "name": "ispublic", "type": "boolean" }, - {}, - { - "description": "the state of the role", - "name": "state", - "type": "string" - }, - {}, { "description": "the type of the role", "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the role", + "name": "state", "type": "string" }, - { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { "description": "the ID of the role", "name": "id", @@ -139785,11 +151686,28 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the name of the role", "name": "name", "type": "string" - } + }, + {}, + { + "description": "the description of the role", + "name": "description", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.9.0" }, @@ -139799,12 +151717,11 @@ "name": "listTungstenFabricPolicy", "params": [ { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the ID of network", @@ -139815,11 +151732,12 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the ID of zone", "length": 255, - "name": "policyuuid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -139829,26 +151747,26 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of ip address", "length": 255, - "name": "keyword", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "pagesize", + "name": "policyuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of ip address", + "description": "", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", @@ -139859,38 +151777,38 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + {}, + {}, { "description": "list Tungsten-Fabric policy network name", "name": "network", "type": "list" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -139898,13 +151816,6 @@ "isasync": true, "name": "downloadImageStoreObject", "params": [ - { - "description": "path to download on image store", - "length": 255, - "name": "path", - "required": false, - "type": "string" - }, { "description": "id of the image store", "length": 255, @@ -139912,23 +151823,21 @@ "related": "listSwifts", "required": true, "type": "uuid" + }, + { + "description": "path to download on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" } ], "related": "extractSnapshot,extractTemplate", "response": [ + {}, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" - }, - { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", - "type": "string" - }, - { - "description": "", - "name": "resultstring", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { @@ -139937,13 +151846,8 @@ "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { @@ -139951,20 +151855,24 @@ "name": "created", "type": "date" }, - {}, { - "description": "the state of the extracted object", - "name": "state", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + }, + { + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { @@ -139973,29 +151881,39 @@ "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, - {}, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "", + "name": "resultstring", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" } ], @@ -140018,10 +151936,11 @@ "related": "", "response": [ { - "description": "the user ID for the cloud identifier", - "name": "userid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the cloud identifier", "name": "cloudidentifier", @@ -140029,20 +151948,19 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the signed response for the cloud identifier", + "name": "signature", "type": "string" }, { - "description": "the signed response for the cloud identifier", - "name": "signature", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user ID for the cloud identifier", + "name": "userid", + "type": "string" } ] }, @@ -140051,6 +151969,21 @@ "isasync": true, "name": "createLBStickinessPolicy", "params": [ + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the description of the load balancer stickiness policy", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "the ID of the load balancer rule", "length": 255, @@ -140060,16 +151993,16 @@ "type": "uuid" }, { - "description": "name of the load balancer stickiness policy", + "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", "length": 255, - "name": "name", + "name": "methodname", "required": true, "type": "string" }, { - "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", + "description": "name of the load balancer stickiness policy", "length": 255, - "name": "methodname", + "name": "name", "required": true, "type": "string" }, @@ -140079,36 +152012,56 @@ "name": "param", "required": false, "type": "map" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the description of the load balancer stickiness policy", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "", "response": [ + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" + }, {}, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the account of the Stickiness policy", + "name": "account", + "type": "string" + }, + { + "description": "the domain of the Stickiness policy", + "name": "domain", + "type": "string" + }, { "description": "the description of the Stickiness policy", "name": "description", @@ -140119,79 +152072,44 @@ "name": "stickinesspolicy", "response": [ { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, { "description": "is policy for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" } ], "type": "list" }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "3.0.0" }, @@ -140201,10 +152119,10 @@ "name": "addCiscoAsa1000vResource", "params": [ { - "description": "the Cluster ID", + "description": "the Physical Network ID", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "physicalnetworkid", + "related": "", "required": true, "type": "uuid" }, @@ -140223,23 +152141,16 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "the Cluster ID", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "clusterid", + "related": "addCluster", "required": true, "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, {}, {}, {}, @@ -140249,6 +152160,13 @@ "name": "jobid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {} ] }, @@ -140275,40 +152193,34 @@ ], "related": "listPaloAltoFirewalls", "response": [ - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, { "description": "device name", "name": "fwdevicename", "type": "string" }, - {}, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { @@ -140316,45 +152228,46 @@ "name": "numretries", "type": "string" }, - {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "device state", + "name": "fwdevicestate", + "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, + {}, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -140363,8 +152276,13 @@ "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", "type": "string" } ] @@ -140375,31 +152293,30 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "The network of the vm the ACL will be created for", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "number", + "name": "reason", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "type of the ICMP message being sent", "length": 255, - "name": "fordisplay", + "name": "icmptype", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "type of the ICMP message being sent", + "description": "the starting port of ACL", "length": 255, - "name": "icmptype", + "name": "startport", "required": false, "type": "integer" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "traffictype", + "name": "protocol", "required": false, "type": "string" }, @@ -140411,25 +152328,26 @@ "type": "string" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "reason", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "partialupgrade", + "name": "number", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the starting port of ACL", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "startport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { "description": "the ID of the network ACL item", @@ -140447,65 +152365,61 @@ "type": "integer" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "cidrlist", + "name": "customid", "required": false, - "type": "list" + "since": "4.4", + "type": "string" }, { - "description": "error code for this ICMP message", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "icmpcode", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "error code for this ICMP message", "length": 255, - "name": "customid", + "name": "icmpcode", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", "length": 255, - "name": "protocol", + "name": "partialupgrade", "required": false, - "type": "string" + "type": "boolean" } ], "related": "moveNetworkAclItem", "response": [ { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, + {}, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { @@ -140513,33 +152427,48 @@ "name": "protocol", "type": "string" }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, { "description": "the ending port of ACL's port range", "name": "endport", "type": "string" }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "an explanation on why this ACL rule is being applied", "name": "reason", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -140548,8 +152477,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -140558,74 +152487,63 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, {}, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, { "description": "type of the icmp message being sent", "name": "icmptype", "type": "integer" }, { - "description": "Number of the ACL Item", - "name": "number", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" } ] }, @@ -140635,26 +152553,18 @@ "name": "listRouters", "params": [ { - "description": "CPU arch of the router", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20.1", - "type": "string" - }, - { - "description": "list virtual router elements by version", + "description": "List by keyword", "length": 255, - "name": "version", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the name of the router", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "the cluster ID of the router", @@ -140665,25 +152575,10 @@ "type": "uuid" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", - "length": 255, - "name": "fetchhealthcheckresults", - "required": false, - "since": "4.14", - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List networks by VPC", "length": 255, - "name": "projectid", - "related": "", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, @@ -140695,34 +152590,34 @@ "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the host ID of the router", "length": 255, - "name": "isrecursive", + "name": "hostid", + "related": "reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the host ID of the router", + "description": "the ID of the disk router", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "id", + "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", "required": false, "type": "uuid" }, { - "description": "List networks by VPC", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list by network id", @@ -140733,17 +152628,18 @@ "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the disk router", + "description": "the Zone ID of the router", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -140755,17 +152651,24 @@ "type": "boolean" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", "length": 255, - "name": "healthchecksfailed", + "name": "fetchhealthcheckresults", "required": false, - "since": "4.16", + "since": "4.14", "type": "boolean" }, { - "description": "the state of the router", + "description": "the name of the router", "length": 255, - "name": "state", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -140778,64 +152681,127 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the state of the router", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID of the router", + "description": "list virtual router elements by version", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "version", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "", + "description": "CPU arch of the router", "length": 255, - "name": "pagesize", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20.1", + "type": "string" + }, + { + "description": "if this parameter is passed, list only routers by health check results", + "length": 255, + "name": "healthchecksfailed", + "required": false, + "since": "4.16", + "type": "boolean" } ], "related": "", "response": [ { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", "type": "string" }, { @@ -140844,125 +152810,154 @@ "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, + {}, { "description": "the public MAC address for the router", "name": "publicmacaddress", "type": "string" }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, { "description": "the project name of the address", "name": "project", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "role of the domain router", + "name": "role", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hostname for the router", + "name": "hostname", + "type": "string" }, - {}, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { @@ -140970,44 +152965,69 @@ "name": "isredundantrouter", "type": "boolean" }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { @@ -141015,18 +153035,8 @@ "name": "nic", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -141035,48 +153045,33 @@ "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -141085,18 +153080,13 @@ "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -141105,174 +153095,102 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" } ], - "type": "list" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "type": "set" } ] }, @@ -141289,12 +153207,11 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -141304,18 +153221,19 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", @@ -141326,11 +153244,6 @@ "type": "string" }, {}, - { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", @@ -141341,17 +153254,22 @@ "name": "name", "type": "string" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", "type": "string" - } + }, + {} ] }, { @@ -141369,7 +153287,6 @@ } ], "response": [ - {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -141381,6 +153298,7 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -141400,40 +153318,32 @@ "name": "addTungstenFabricPolicyRule", "params": [ { - "description": "Tungsten-Fabric policy rule destination network", + "description": "Tungsten-Fabric policy rule source ip prefix", "length": 255, - "name": "destnetwork", + "name": "srcipprefix", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix", + "description": "Tungsten-Fabric policy rule direction", "length": 255, - "name": "destipprefix", + "name": "direction", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", - "length": 255, - "name": "destipprefixlen", - "required": true, - "type": "integer" - }, - { - "description": "the ID of zone", + "description": "Tungsten-Fabric policy rule destination network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "destnetwork", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source start port", + "description": "Tungsten-Fabric policy rule destination ip prefix", "length": 255, - "name": "srcstartport", + "name": "destipprefix", "required": true, - "type": "integer" + "type": "string" }, { "description": "Tungsten-Fabric policy rule source end port", @@ -141443,18 +153353,18 @@ "type": "integer" }, { - "description": "Tungsten-Fabric policy rule protocol", + "description": "Tungsten-Fabric policy rule source ip prefix length", "length": 255, - "name": "protocol", + "name": "srcipprefixlen", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "Tungsten-Fabric policy rule destination ip prefix length", "length": 255, - "name": "policyuuid", + "name": "destipprefixlen", "required": true, - "type": "string" + "type": "integer" }, { "description": "Tungsten-Fabric policy rule destination start port", @@ -141464,25 +153374,32 @@ "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination end port", + "description": "Tungsten-Fabric policy rule source start port", "length": 255, - "name": "destendport", + "name": "srcstartport", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule source ip prefix", + "description": "Tungsten-Fabric policy rule source network", "length": 255, - "name": "srcipprefix", + "name": "srcnetwork", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule source ip prefix length", + "description": "Tungsten-Fabric policy rule protocol", "length": 255, - "name": "srcipprefixlen", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" }, { "description": "Tungsten-Fabric policy rule action", @@ -141492,40 +153409,36 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy rule source network", + "description": "Tungsten-Fabric policy rule destination end port", "length": 255, - "name": "srcnetwork", + "name": "destendport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule direction", + "description": "the ID of zone", "length": 255, - "name": "direction", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", "type": "int" }, { @@ -141534,23 +153447,13 @@ "type": "int" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", - "type": "string" - }, - { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { @@ -141559,15 +153462,24 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", "type": "int" }, - {}, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "direction", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" }, { "description": "Tungsten-Fabric policy destination ip prefix length", @@ -141586,14 +153498,9 @@ }, {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -141601,9 +153508,20 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -141613,19 +153531,25 @@ "name": "createWebhook", "params": [ { - "description": "Payload URL of the Webhook", + "description": "Description for the Webhook", "length": 255, - "name": "payloadurl", + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "Name for the Webhook", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "Project for the Webhook", + "description": "State of the Webhook", "length": 255, - "name": "projectid", - "related": "", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { "description": "If set to true then SSL verification will be done for the Webhook otherwise not", @@ -141635,9 +153559,16 @@ "type": "boolean" }, { - "description": "State of the Webhook", + "description": "Secret key of the Webhook", "length": 255, - "name": "state", + "name": "secretkey", + "required": false, + "type": "string" + }, + { + "description": "Scope of the Webhook", + "length": 255, + "name": "scope", "required": false, "type": "string" }, @@ -141650,91 +153581,84 @@ "type": "uuid" }, { - "description": "Description for the Webhook", + "description": "An optional account for the Webhook. Must be used with domainId.", "length": 255, - "name": "description", + "name": "account", "required": false, "type": "string" }, { - "description": "Name for the Webhook", + "description": "Payload URL of the Webhook", "length": 255, - "name": "name", + "name": "payloadurl", "required": true, "type": "string" }, { - "description": "Scope of the Webhook", - "length": 255, - "name": "scope", - "required": false, - "type": "string" - }, - { - "description": "Secret key of the Webhook", - "length": 255, - "name": "secretkey", - "required": false, - "type": "string" - }, - { - "description": "An optional account for the Webhook. Must be used with domainId.", + "description": "Project for the Webhook", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, + { + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" + }, { "description": "The payload URL end point for the Webhook", "name": "payloadurl", "type": "string" }, + {}, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "The state of the Webhook", - "name": "state", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The account associated with the Webhook", + "name": "account", + "type": "string" }, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, { @@ -141742,37 +153666,31 @@ "name": "project", "type": "string" }, + {}, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, - { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" - }, - {}, { "description": "The scope of the Webhook", "name": "scope", "type": "string" }, { - "description": "The ID of the Webhook", - "name": "id", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "The name of the Webhook", - "name": "name", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" } ], "since": "4.20.0" @@ -141783,17 +153701,10 @@ "name": "removeVpnUser", "params": [ { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "remove vpn user from the project", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -141805,24 +153716,27 @@ "type": "string" }, { - "description": "remove vpn user from the project", + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" + }, + { + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", @@ -141830,11 +153744,15 @@ "type": "string" }, {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -141844,25 +153762,25 @@ "name": "listQuarantinedIps", "params": [ { - "description": "", + "description": "Show IPs that are no longer in quarantine.", "length": 255, - "name": "page", + "name": "showinactive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "Show IPs removed from quarantine.", @@ -141872,15 +153790,16 @@ "type": "boolean" }, { - "description": "Show IPs that are no longer in quarantine.", + "description": "", "length": 255, - "name": "showinactive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "updateQuarantinedIp", "response": [ + {}, { "description": "ID of the quarantine process.", "name": "id", @@ -141892,28 +153811,23 @@ "type": "string" }, { - "description": "End date for the quarantine.", - "name": "enddate", + "description": "When the quarantine was removed.", + "name": "removed", "type": "date" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", - "type": "string" - }, - { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "When the quarantine was removed.", - "name": "removed", + "description": "When the quarantine was created.", + "name": "created", "type": "date" }, { @@ -141922,22 +153836,26 @@ "type": "integer" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" }, - {} + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", + "type": "string" + } ], "since": "4.19" }, @@ -141956,18 +153874,17 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -141977,7 +153894,8 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {} ], "since": "4.2.0" }, @@ -141986,10 +153904,17 @@ "isasync": false, "name": "listSwifts", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -142000,17 +153925,10 @@ "required": false, "type": "long" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -142018,25 +153936,24 @@ "related": "", "response": [ { - "description": "the url of the image store", - "name": "url", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the url of the image store", + "name": "url", + "type": "string" }, - {}, { "description": "the provider name of the image store", "name": "providername", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "the host's currently used disk size", @@ -142044,24 +153961,8 @@ "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { @@ -142069,14 +153970,20 @@ "name": "protocol", "type": "string" }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -142085,9 +153992,20 @@ "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + {}, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" } ], "since": "3.0.0" @@ -142113,37 +154031,37 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, { "description": "if host HA is enabled for the host", "name": "haenable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the host HA provider", - "name": "haprovider", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, { "description": "operation status", "name": "status", "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, {} ], "since": "4.11" @@ -142164,20 +154082,16 @@ ], "related": "", "response": [ + {}, {}, { - "description": "the operation result description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { @@ -142186,14 +154100,19 @@ "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" }, { "description": "the out-of-band management interface powerState of the host", @@ -142201,34 +154120,33 @@ "type": "powerstate" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { "description": "the out-of-band management driver for the host", "name": "driver", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the out-of-band management interface address", "name": "address", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the operation result description", + "name": "description", "type": "string" } ], @@ -142249,21 +154167,21 @@ } ], "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", @@ -142279,19 +154197,12 @@ "name": "listKubernetesSupportedVersions", "params": [ { - "description": "the ID of the zone in which Kubernetes supported version will be available", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "pagesize", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20", + "type": "string" }, { "description": "the ID of the minimum Kubernetes supported version", @@ -142302,32 +154213,31 @@ "type": "uuid" }, { - "description": "the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64", + "description": "List by keyword", "length": 255, - "name": "arch", + "name": "keyword", "required": false, - "since": "4.20", "type": "string" }, { - "description": "the ID of the Kubernetes supported version", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -142337,55 +154247,57 @@ "name": "minimumsemanticversion", "required": false, "type": "string" + }, + { + "description": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "related": "listKubernetesSupportedVersions", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" - }, - { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, - {}, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" }, {}, { @@ -142394,8 +154306,8 @@ "type": "boolean" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { @@ -142404,13 +154316,14 @@ "type": "boolean" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, + {}, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { @@ -142419,19 +154332,24 @@ "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" } ] }, @@ -142441,26 +154359,18 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "Credentials to access the Nicira Controller API", + "description": "The Transportzone UUID configured on the Nicira Controller", "length": 255, - "name": "username", + "name": "transportzoneuuid", "required": true, "type": "string" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l3gatewayserviceuuid", - "required": false, - "type": "string" - }, - { - "description": "the Physical Network ID", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "hostname", "required": true, - "type": "uuid" + "type": "string" }, { "description": "The L2 Gateway Service UUID configured on the Nicira Controller", @@ -142470,42 +154380,45 @@ "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "transportzoneuuid", + "name": "password", "required": true, "type": "string" }, { "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "Hostname of ip address of the Nicira NVP Controller.", + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "hostname", - "required": true, + "name": "l3gatewayserviceuuid", + "required": false, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the controller Ip address", - "name": "hostname", + "description": "device name", + "name": "niciradevicename", "type": "string" }, { @@ -142513,20 +154426,21 @@ "name": "l3gatewayserviceuuid", "type": "string" }, + {}, + {}, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the provider", - "name": "provider", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { @@ -142534,15 +154448,19 @@ "name": "l2gatewayserviceuuid", "type": "string" }, - {}, { - "description": "device name", - "name": "niciradevicename", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the controller Ip address", + "name": "hostname", + "type": "string" + }, + { + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" } ] @@ -142554,56 +154472,60 @@ "params": [], "related": "", "response": [ + {}, { - "description": "Number of internal LBs", - "name": "ilbvms", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Number of images stores", + "name": "imagestores", + "type": "integer" }, - {}, { "description": "Number of pods", "name": "pods", "type": "integer" }, { - "description": "Number of object stores", - "name": "objectstores", + "description": "Number of hypervisor hosts", + "name": "hosts", "type": "integer" }, { - "description": "Number of routers", - "name": "routers", + "description": "Number of internal LBs", + "name": "ilbvms", "type": "integer" }, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of management servers", + "name": "managementservers", "type": "integer" }, { - "description": "Number of Alerts", - "name": "alerts", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" }, { - "description": "Number of management servers", - "name": "managementservers", + "description": "Number of clusters", + "name": "clusters", "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", + "description": "Number of routers", + "name": "routers", "type": "integer" }, { @@ -142611,9 +154533,10 @@ "name": "zones", "type": "integer" }, + {}, { - "description": "Number of clusters", - "name": "clusters", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -142622,13 +154545,8 @@ "type": "integer" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Number of object stores", + "name": "objectstores", "type": "integer" } ], @@ -142640,40 +154558,34 @@ "name": "listUsageRecords", "params": [ { - "description": "Start date range for usage record query. 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.", - "length": 255, - "name": "startdate", - "required": true, - "type": "date" - }, - { - "description": "List usage records for the specified account", + "description": "List by keyword", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "", "length": 255, - "name": "includetags", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "description": "List usage records for specified project", "length": 255, - "name": "usageid", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List usage records for the specified usage type", + "description": "List usage records for the specified domain.", "length": 255, - "name": "type", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "long" + "type": "uuid" }, { "description": "", @@ -142683,25 +154595,17 @@ "type": "integer" }, { - "description": "List usage records for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "Start date range for usage record query. 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.", "length": 255, - "name": "oldformat", - "required": false, - "type": "boolean" + "name": "startdate", + "required": true, + "type": "date" }, { - "description": "List usage records for specified project", + "description": "List usage records for the specified account", "length": 255, - "name": "projectid", - "related": "", + "name": "accountid", + "related": "enableAccount,listAccounts", "required": false, "type": "uuid" }, @@ -142713,20 +154617,12 @@ "type": "string" }, { - "description": "List by keyword", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "keyword", + "name": "usageid", "required": false, "type": "string" }, - { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", - "length": 255, - "name": "isrecursive", - "required": false, - "since": "4.15", - "type": "boolean" - }, { "description": "End date range for usage record query. 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.", "length": 255, @@ -142735,49 +154631,45 @@ "type": "date" }, { - "description": "", + "description": "List usage records for the specified usage type", "length": 255, - "name": "page", + "name": "type", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "template ID", - "name": "templateid", - "type": "string" + "type": "long" }, - {}, { - "description": "offering ID", - "name": "offeringid", - "type": "string" + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "length": 255, + "name": "oldformat", + "required": false, + "type": "boolean" }, { - "description": "virtual machine os display name", - "name": "osdisplayname", - "type": "string" + "description": "Flag to enable display of Tags for a resource", + "length": 255, + "name": "includetags", + "required": false, + "type": "boolean" }, { - "description": "the user account Id", - "name": "accountid", - "type": "string" - }, + "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "length": 255, + "name": "isrecursive", + "required": false, + "since": "4.15", + "type": "boolean" + } + ], + "related": "", + "response": [ { - "description": "the project id of the resource", - "name": "projectid", + "description": "the user account name", + "name": "account", "type": "string" }, { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" - }, - { - "description": "description of the usage record", - "name": "description", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, { @@ -142785,152 +154677,117 @@ "name": "enddate", "type": "date" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the domain ID", "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "type", - "type": "string" - }, - { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" - }, - { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "id of the vpc", - "name": "vpcid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "usageid", - "type": "string" - }, - { - "description": "speed of each cpu of resource", - "name": "cpuspeed", + "description": "resource size", + "name": "size", "type": "long" }, { - "description": "id of the network", - "name": "networkid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "virtual machine os category name", + "name": "oscategoryname", "type": "string" }, { - "description": "usage in hours", - "name": "usage", + "description": "the project name of the resource", + "name": "project", "type": "string" }, - { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", - "type": "boolean" - }, - {}, - { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "resource size", - "name": "size", + "description": "id of the network", + "name": "networkid", + "type": "string" + }, + { + "description": "template ID", + "name": "templateid", + "type": "string" + }, + { + "description": "number of cpu of resource", + "name": "cpunumber", "type": "long" }, { - "description": "start date of the usage record", - "name": "startdate", - "type": "date" + "description": "description of the usage record", + "name": "description", + "type": "string" }, { - "description": "path of the domain to which the usage reocrd belongs", - "name": "domainpath", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { - "description": "the project name of the resource", - "name": "project", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { @@ -142939,43 +154796,74 @@ "type": "string" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", + "description": "True if the resource is default", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "virtual machine guest os category ID", + "name": "oscategoryid", "type": "string" }, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "usage type ID", + "name": "usagetype", + "type": "integer" + }, + {}, + { + "description": "the user account Id", + "name": "accountid", "type": "string" }, { - "description": "number of cpu of resource", - "name": "cpunumber", + "description": "usage in hours", + "name": "usage", + "type": "string" + }, + { + "description": "resource type", + "name": "type", + "type": "string" + }, + { + "description": "speed of each cpu of resource", + "name": "cpuspeed", "type": "long" }, { - "description": "True if the resource is default", - "name": "isdefault", + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", "type": "boolean" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user account name", - "name": "account", + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" + }, + { + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" + }, + { + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "id of the resource", + "name": "usageid", "type": "string" }, { - "description": "the zone ID", - "name": "zoneid", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { @@ -142984,14 +154872,44 @@ "type": "boolean" }, { - "description": "the domain the resource is associated with", - "name": "domain", + "description": "the project id of the resource", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "start date of the usage record", + "name": "startdate", + "type": "date" + }, + { + "description": "path of the domain to which the usage reocrd belongs", + "name": "domainpath", "type": "string" }, + { + "description": "virtual machine os display name", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", + "type": "boolean" + }, { "description": "virtual machine ID", "name": "virtualmachineid", "type": "string" + }, + { + "description": "offering ID", + "name": "offeringid", + "type": "string" } ] }, @@ -143012,34 +154930,39 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "IO requests write rate of the disk volume per the disk offering", @@ -143047,18 +154970,23 @@ "type": "long" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { @@ -143066,146 +154994,55 @@ "name": "deleteprotection", "type": "boolean" }, - {}, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, { "description": "the account associated with the disk volume", "name": "account", "type": "string" }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, { "description": "the disk utilization", "name": "utilization", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the status of the volume", + "name": "status", "type": "string" }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, { "description": "min iops of the disk volume", "name": "miniops", "type": "long" }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", @@ -143217,8 +155054,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -143227,8 +155069,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -143237,26 +155079,26 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -143265,144 +155107,175 @@ "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, - {}, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, + {}, { "description": "the bytes allocated", "name": "virtualsize", "type": "long" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + {}, { "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", "name": "deviceid", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { @@ -143411,29 +155284,74 @@ "type": "map" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, { "description": "shared or local storage", "name": "storagetype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" } ], "since": "4.14.0" @@ -143443,13 +155361,6 @@ "isasync": true, "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ - { - "description": "Tungsten-Fabric network uuid", - "length": 255, - "name": "networkuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -143464,10 +155375,22 @@ "name": "logicalrouteruuid", "required": true, "type": "string" + }, + { + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, + "type": "string" } ], "related": "", "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", @@ -143478,23 +155401,16 @@ "name": "uuid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Tungsten-Fabric logical router name", "name": "name", @@ -143504,7 +155420,9 @@ "description": "list Tungsten-Fabric policy network name", "name": "network", "type": "list" - } + }, + {}, + {} ] }, { @@ -143513,16 +155431,16 @@ "name": "listVolumesForImport", "params": [ { - "description": "", + "description": "the path of the volume on the storage pool", "length": 255, - "name": "page", + "name": "path", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -143535,11 +155453,11 @@ "type": "uuid" }, { - "description": "the path of the volume on the storage pool", + "description": "", "length": 255, - "name": "path", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -143551,15 +155469,16 @@ ], "related": "", "response": [ + {}, { - "description": "the encrypt format of the volume", - "name": "encryptformat", + "description": "the full path of the volume", + "name": "fullpath", "type": "string" }, { - "description": "the size of the volume", - "name": "size", - "type": "long" + "description": "id of the primary storage hosting the volume", + "name": "storageid", + "type": "string" }, { "description": "type of the primary storage hosting the volume", @@ -143567,40 +155486,29 @@ "type": "string" }, { - "description": "the full path of the volume", - "name": "fullpath", - "type": "string" - }, - {}, - {}, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "the size of the volume", + "name": "size", + "type": "long" }, { - "description": "the name of the volume", - "name": "name", + "description": "name of the primary storage hosting the volume", + "name": "storage", "type": "string" }, + {}, { "description": "volume details in key/value pairs.", "name": "details", "type": "map" }, - { - "description": "id of the primary storage hosting the volume", - "name": "storageid", - "type": "string" - }, { "description": "the virtual size of the volume", "name": "virtualsize", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the format of the volume", + "name": "format", "type": "string" }, { @@ -143608,19 +155516,29 @@ "name": "path", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "name of the primary storage hosting the volume", - "name": "storage", + "description": "the name of the volume", + "name": "name", "type": "string" }, { - "description": "the format of the volume", - "name": "format", + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the encrypt format of the volume", + "name": "encryptformat", "type": "string" } ], @@ -143631,6 +155549,36 @@ "isasync": false, "name": "listZonesMetrics", "params": [ + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "description": "flag to display the capacity of the zones", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" + }, + { + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -143660,13 +155608,6 @@ "required": false, "type": "uuid" }, - { - "description": "flag to display the capacity of the zones", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, { "description": "the IDs of the zones, mutually exclusive with id", "length": 255, @@ -143676,6 +155617,13 @@ "since": "4.19.0", "type": "list" }, + { + "description": "the name of the zone", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "flag to display the resource image for the zones", "length": 255, @@ -143684,11 +155632,11 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", "length": 255, - "name": "keyword", + "name": "available", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the ID of the zone", @@ -143697,46 +155645,34 @@ "related": "listZones", "required": false, "type": "uuid" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the zone", - "length": 255, - "name": "name", - "required": false, + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", - "length": 255, - "name": "available", - "required": false, + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "since": "4.3", - "type": "map" - } - ], - "related": "", - "response": [ - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "External network provider if any", + "name": "provider", + "type": "string" }, { "description": "the second internal DNS for the Zone", @@ -143744,39 +155680,29 @@ "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "AS Number Range", + "name": "asnrange", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" }, { "description": "the maximum cpu deviation", @@ -143784,134 +155710,186 @@ "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "Zone description", - "name": "description", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, - {}, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, + {}, { "description": "the type of the zone - core or edge", "name": "type", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" }, { - "description": "healthy / total clusters in the zone", - "name": "clusters", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", + "description": "the list of resource tags associated with zone.", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", "type": "boolean" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" }, { - "description": "state of the cluster", - "name": "state", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { @@ -143919,13 +155897,8 @@ "name": "capacity", "response": [ { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -143934,13 +155907,8 @@ "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -143948,15 +155916,20 @@ "name": "zoneid", "type": "string" }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, { "description": "the Zone name", "name": "zonename", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the capacity type", @@ -143964,9 +155937,9 @@ "type": "short" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the Pod name", @@ -143974,52 +155947,62 @@ "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" } ], "type": "list" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "state of the cluster", + "name": "state", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { "description": "Zone id", @@ -144027,92 +156010,55 @@ "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", "type": "boolean" }, {}, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "Zone name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" } ], "since": "4.9.3" @@ -144138,41 +156084,46 @@ "type": "string" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the ID of the template", "length": 255, - "name": "mode", + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the template", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "id", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "mode", "required": true, - "type": "uuid" + "type": "string" } ], "related": "extractSnapshot", "response": [ { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { @@ -144180,9 +156131,10 @@ "name": "zoneid", "type": "string" }, + {}, { - "description": "type of the storage", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -144191,34 +156143,24 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, + {}, { "description": "the percentage of the entity uploaded to the specified location", "name": "uploadpercentage", "type": "integer" }, { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the time and date the object was created", - "name": "created", - "type": "date" - }, - { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { @@ -144227,8 +156169,8 @@ "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { @@ -144236,7 +156178,11 @@ "name": "state", "type": "string" }, - {} + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + } ] }, { @@ -144248,18 +156194,18 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "required": true, "type": "uuid" } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -144272,8 +156218,8 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -144291,14 +156237,6 @@ "since": "4.4", "type": "string" }, - { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "the ID of the public IP address to update", "length": 255, @@ -144306,42 +156244,92 @@ "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" + }, + { + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the project name of the address", - "name": "project", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "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", - "name": "purpose", + "description": "public IP address id", + "name": "id", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + {}, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + {}, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, { "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -144350,33 +156338,33 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -144388,28 +156376,38 @@ "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "list" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { @@ -144418,13 +156416,18 @@ "type": "integer" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { @@ -144433,74 +156436,59 @@ "type": "date" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, - { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, { "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", "name": "hasrules", "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "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", + "name": "purpose", "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "public IP address id", - "name": "id", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { "description": "the name of the Network where ip belongs to", @@ -144508,60 +156496,23 @@ "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" }, - {}, { "description": "virtual machine id the ip address is assigned to", "name": "virtualmachineid", "type": "string" }, - { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", - "type": "string" - }, - {}, { "description": "virtual machine type the ip address is assigned to", "name": "virtualmachinetype", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", - "type": "string" - }, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ] @@ -144572,12 +156523,11 @@ "name": "migrateNetwork", "params": [ { - "description": "network offering ID", + "description": "true if previous network migration cmd failed", "length": 255, - "name": "networkofferingid", - "related": "", - "required": true, - "type": "uuid" + "name": "resume", + "required": false, + "type": "boolean" }, { "description": "the ID of the network", @@ -144588,230 +156538,225 @@ "type": "uuid" }, { - "description": "true if previous network migration cmd failed", + "description": "network offering ID", "length": 255, - "name": "resume", - "required": false, - "type": "boolean" + "name": "networkofferingid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "createNetwork,updateNetwork,listNetworks", "response": [ { - "description": "the network's netmask", - "name": "netmask", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "zone id of the network", - "name": "zoneid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, - {}, { - "description": "the name of the network", - "name": "name", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { "description": "true if network can span multiple zones", @@ -144819,58 +156764,38 @@ "type": "boolean" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { @@ -144878,101 +156803,19 @@ "name": "zonesnetworkspans", "type": "set" }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, { "description": "display text of the network offering the network is created from", "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "state of the network", - "name": "state", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { @@ -144980,31 +156823,24 @@ "name": "service", "response": [ { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability name", + "description": "the provider name", "name": "name", "type": "string" }, { - "description": "the capability value", - "name": "value", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, { "description": "state of the network provider", "name": "state", @@ -145015,122 +156851,227 @@ "name": "id", "type": "string" }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "services for this provider", "name": "servicelist", "type": "list" - }, + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, - {}, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "true network requires restart", "name": "restartrequired", "type": "boolean" }, + {}, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" } ], "since": "4.11.0" @@ -145140,14 +157081,6 @@ "isasync": false, "name": "listUnmanagedInstances", "params": [ - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" - }, { "description": "the hypervisor name of the instance", "length": 255, @@ -145156,11 +157089,19 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" }, { "description": "", @@ -145170,78 +157111,101 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "indicates the boot mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the controller of the disk", + "name": "controller", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the position of the disk", + "name": "position", "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the label of the disk", + "name": "label", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the controller of the disk", + "name": "datastorename", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { "description": "the isolated private VLAN type if available", @@ -145249,242 +157213,219 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, - { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "indicates the boot type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" - }, - { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ + }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the label of the disk", - "name": "label", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" } ], "type": "set" }, - {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" }, { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "indicates the boot type", + "name": "boottype", "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, { "description": "the operating system ID of the virtual machine", "name": "osid", "type": "string" }, + {}, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "indicates the boot mode", - "name": "bootmode", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.14.0" }, @@ -145494,17 +157435,18 @@ "name": "registerTemplate", "params": [ { - "description": "32 or 64 bits support. 64 by default", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "bits", + "name": "directdownload", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "format", - "required": true, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { @@ -145515,11 +157457,20 @@ "type": "boolean" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "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. ", + "length": 255, + "name": "zoneids", + "related": "listZones", + "required": false, + "type": "list" + }, + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", @@ -145530,18 +157481,18 @@ "type": "boolean" }, { - "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 \"{}\", not including the double quotes. In this 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.", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "checksum", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the template", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "details", + "required": false, + "type": "map" }, { "description": "true if the template type is routing i.e., if template is used to deploy router", @@ -145550,6 +157501,22 @@ "required": false, "type": "boolean" }, + { + "description": "ID of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions", + "required": false, + "since": "4.21.0", + "type": "uuid" + }, + { + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, { "description": "Register template for the project", "length": 255, @@ -145559,68 +157526,82 @@ "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if this template requires HVM", "length": 255, - "name": "sshkeyenabled", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "directdownload", + "name": "format", + "required": true, + "type": "string" + }, + { + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "bits", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "true if the template is available to all accounts; default is true", + "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", "length": 255, - "name": "ispublic", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the target hypervisor for the template", + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the name of the template", "length": 255, - "name": "hypervisor", + "name": "name", "required": true, "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "isfeatured", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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. ", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "zoneids", + "name": "zoneid", "related": "listZones", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "isdynamicallyscalable", + "name": "ispublic", "required": false, "type": "boolean" }, @@ -145631,6 +157612,14 @@ "required": false, "type": "string" }, + { + "description": "if true, the templates would be available for deploying CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, { "description": "an optional accountName. Must be used with domainId.", "length": 255, @@ -145639,79 +157628,112 @@ "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "details", + "name": "externaldetails", "required": false, + "since": "4.21.0", "type": "map" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "templatetype", + "name": "isdynamicallyscalable", "required": false, - "since": "4.19.0", - "type": "string" + "type": "boolean" }, { - "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", + "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 \"{}\", not including the double quotes. In this 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.", "length": 255, - "name": "ostypeid", - "related": "", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "the tag for this template.", "length": 255, - "name": "arch", + "name": "templatetag", "required": false, - "since": "4.20", + "type": "string" + } + ], + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if this template requires HVM", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "true if the template or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" - } - ], - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ + }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + {}, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { "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", @@ -145719,155 +157741,165 @@ "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { @@ -145876,161 +157908,111 @@ "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, { "description": "the physical size of the template", "name": "physicalsize", "type": "long" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, + {}, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, + {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - {}, { "description": "the hypervisor on which the template runs", "name": "hypervisor", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" } ] }, @@ -146040,56 +158022,69 @@ "name": "listVnfAppliances", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "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", "required": false, "type": "uuid" }, { - "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.", + "description": "list vms by vpc", "length": 255, - "name": "isvnf", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "since": "4.19.0", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "pagesize", + "name": "extensionid", + "related": "listExtensions", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "haenable", + "name": "account", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" }, { - "description": "comma separated list of vm 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.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "details", + "name": "projectid", + "related": "", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "state", + "name": "autoscalevmgroupid", + "related": "", "required": false, - "type": "string" + "since": "4.18.0", + "type": "uuid" }, { - "description": "", + "description": "comma separated list of vm 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.", "length": 255, - "name": "page", + "name": "details", "required": false, - "type": "integer" + "type": "list" + }, + { + "description": "the instances by userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.20.1", + "type": "uuid" }, { "description": "list vms by iso", @@ -146099,84 +158094,89 @@ "type": "uuid" }, { - "description": "list by the service offering", + "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "state", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "list by the backup offering", + "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.", "length": 255, - "name": "backupofferingid", - "related": "", + "name": "isvnf", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the group ID", + "description": "", "length": 255, - "name": "groupid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the instances by userdata", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "userdataid", - "related": "", + "name": "haenable", "required": false, - "since": "4.20.1", - "type": "uuid" + "since": "4.15", + "type": "boolean" }, { - "description": "list vms by affinity group", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "displayvm", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list vms by template", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the target hypervisor for the template", "length": 255, - "name": "isrecursive", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { - "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.", + "description": "CPU arch of the VM", "length": 255, - "name": "listall", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20.1", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "displayvm", + "name": "showicon", "required": false, - "since": "4.4", + "since": "4.16.0.0", "type": "boolean" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the virtual machine", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "ids", + "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", "required": false, - "type": "uuid" + "since": "4.4", + "type": "list" }, { "description": "the security group ID", @@ -146188,35 +158188,28 @@ "type": "uuid" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" - }, - { - "description": "list vms by vpc", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "userid", + "related": "getUser", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", "length": 255, - "name": "projectid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list by the service offering", "length": 255, - "name": "forvirtualnetwork", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { "description": "List by keyword", @@ -146226,12 +158219,11 @@ "type": "string" }, { - "description": "CPU arch of the VM", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "arch", + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.20.1", - "type": "string" + "type": "boolean" }, { "description": "the availability zone ID", @@ -146242,87 +158234,102 @@ "type": "uuid" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "Whether to return only leased instances", "length": 255, - "name": "userid", - "related": "getUser", + "name": "leased", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "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.", "length": 255, - "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "listall", "required": false, - "since": "4.4", - "type": "list" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list by the backup offering", "length": 255, - "name": "tags", + "name": "backupofferingid", + "related": "", "required": false, - "type": "map" + "since": "4.17", + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", "length": 255, - "name": "account", + "name": "accumulate", "required": false, - "type": "string" + "since": "4.17.0", + "type": "boolean" }, { - "description": "the ID of AutoScaling VM Group", + "description": "list vms by affinity group", "length": 255, - "name": "autoscalevmgroupid", + "name": "affinitygroupid", "related": "", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "list by network id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "flag to display the resource icon for VMs", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "showicon", + "name": "forvirtualnetwork", "required": false, - "since": "4.16.0.0", "type": "boolean" }, { - "description": "list vms by ssh keypair name", + "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.", "length": 255, - "name": "keypair", + "name": "gpuenabled", "required": false, - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "list vms by template", + "description": "the group ID", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "groupid", + "related": "", "required": false, "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the target hypervisor for the template", + "description": "list by network id", "length": 255, - "name": "hypervisor", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", "required": false, "type": "string" }, @@ -146335,72 +158342,77 @@ "type": "boolean" } ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "response": [ { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { "description": "the pool type of the virtual machine", @@ -146408,94 +158420,158 @@ "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, - {}, - {}, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -146504,29 +158580,39 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { "description": "the extra dhcp options on the nic", @@ -146534,8 +158620,8 @@ "type": "list" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -146554,225 +158640,92 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, { "description": "the memory allocated for the virtual machine", "name": "memory", "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - {}, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": "the write (IO) of disk on the VM", @@ -146780,127 +158733,55 @@ "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the description of the affinity group", + "description": "the description of the security group", "name": "description", "type": "string" }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -146908,14 +158789,19 @@ "name": "project", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -146924,36 +158810,31 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -146962,19 +158843,14 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "the type of the ICMP message response", @@ -146982,129 +158858,126 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, { "description": "the project name of the group", "name": "project", "type": "string" }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag value", + "name": "value", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -147113,23 +158986,23 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -147138,144 +159011,173 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" } ], "type": "set" }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, + {}, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -147284,155 +159186,320 @@ "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, { "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" - } + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + {} ], "since": "4.19.1" }, @@ -147442,19 +159509,12 @@ "name": "addStratosphereSsp", "params": [ { - "description": "stratosphere ssp api username", + "description": "stratosphere ssp api password", "length": 255, - "name": "username", + "name": "password", "required": false, "type": "string" }, - { - "description": "stratosphere ssp server url", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, { "description": "stratosphere ssp api name", "length": 255, @@ -147463,16 +159523,9 @@ "type": "string" }, { - "description": "stratosphere ssp api password", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, - { - "description": "stratosphere ssp tenant uuid", + "description": "stratosphere ssp api username", "length": 255, - "name": "tenantuuid", + "name": "username", "required": false, "type": "string" }, @@ -147483,13 +159536,33 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "stratosphere ssp server url", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "stratosphere ssp tenant uuid", + "length": 255, + "name": "tenantuuid", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "url of ssp endpoint", - "name": "url", + "description": "server id of the stratosphere ssp server", + "name": "hostid", + "type": "string" + }, + { + "description": "name", + "name": "name", "type": "string" }, { @@ -147507,18 +159580,12 @@ "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", + "description": "url of ssp endpoint", + "name": "url", "type": "string" }, - { - "description": "name", - "name": "name", - "type": "string" - } + {} ] }, { @@ -147527,53 +159594,40 @@ "name": "createStoragePool", "params": [ { - "description": "bytes CloudStack can provision from this storage pool", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" - }, - { - "description": "the storage provider name", + "description": "the URL of the storage pool", "length": 255, - "name": "provider", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "whether the storage should be managed by CloudStack", - "length": 255, - "name": "managed", - "required": false, - "type": "boolean" - }, - { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "description": "comma separated list of storage access groups for connecting to hosts having those specific groups", "length": 255, - "name": "hypervisor", + "name": "storageaccessgroups", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "the name for the storage pool", + "description": "the tags for the storage pool", "length": 255, - "name": "name", - "required": true, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the scope of the storage: cluster or zone", + "description": "whether the storage should be managed by CloudStack", "length": 255, - "name": "scope", + "name": "managed", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the tags for the storage pool", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "tags", + "name": "istagarule", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the Zone ID for the storage pool", @@ -147583,6 +159637,13 @@ "required": true, "type": "uuid" }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" + }, { "description": "the Pod ID for the storage pool", "length": 255, @@ -147599,66 +159660,70 @@ "type": "map" }, { - "description": "the URL of the storage pool", + "description": "the cluster ID for the storage pool", "length": 255, - "name": "url", + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the name for the storage pool", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "the cluster ID for the storage pool", + "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "capacityiops", + "name": "capacitybytes", "required": false, "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "the storage provider name", "length": 255, - "name": "istagarule", + "name": "provider", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "the scope of the storage: cluster or zone", + "length": 255, + "name": "scope", + "required": false, + "type": "string" } ], "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the storage pool capabilities", - "name": "storagecapabilities", + "description": "the storage pool custom stats", + "name": "storagecustomstats", "type": "map" }, - { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "whether this pool is managed or not", "name": "managed", "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" }, { "description": "the overprovisionfactor for the storage pool", @@ -147666,54 +159731,40 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the storage pool type", - "name": "type", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, { "description": "the Pod name of the storage pool", "name": "podname", "type": "string" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { "description": "the name of the cluster for the storage pool", @@ -147721,24 +159772,18 @@ "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the storage pool type", + "name": "type", "type": "string" }, { @@ -147746,14 +159791,15 @@ "name": "zoneid", "type": "string" }, + {}, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { @@ -147761,41 +159807,80 @@ "name": "disksizetotal", "type": "long" }, - {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" } ] }, @@ -147811,6 +159896,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the volume", "length": 255, @@ -147825,41 +159917,44 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the Zone ID of the storage pool", @@ -147867,35 +159962,29 @@ "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" - }, - {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, + {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { @@ -147904,33 +159993,34 @@ "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -147939,23 +160029,13 @@ "type": "map" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -147964,44 +160044,59 @@ "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" } ] }, @@ -148027,28 +160122,28 @@ } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ] }, { @@ -148072,16 +160167,15 @@ "name": "ipaddress", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "device name", + "name": "vsmdevicename", + "type": "string" }, { "description": "The mode of the VSM (standalone/HA)", @@ -148089,55 +160183,56 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device state", + "name": "vsmdevicestate", + "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device name", - "name": "vsmdevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "management vlan id of the VSM", "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, + {}, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", "type": "int" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, - {}, { - "description": "device state", - "name": "vsmdevicestate", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" } ] }, @@ -148147,11 +160242,12 @@ "name": "createStorageNetworkIpRange", "params": [ { - "description": "the beginning IP address", + "description": "UUID of pod where the ip range belongs to", "length": 255, - "name": "startip", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the ending IP address", @@ -148161,24 +160257,23 @@ "type": "string" }, { - "description": "the netmask for storage network", + "description": "the gateway for storage network", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, { - "description": "UUID of pod where the ip range belongs to", + "description": "the beginning IP address", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "startip", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the gateway for storage network", + "description": "the netmask for storage network", "length": 255, - "name": "gateway", + "name": "netmask", "required": true, "type": "string" }, @@ -148193,60 +160288,60 @@ "related": "", "response": [ { - "description": "the uuid of storage network IP range.", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, + {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" } ], @@ -148257,13 +160352,6 @@ "isasync": true, "name": "configureOvsElement", "params": [ - { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - }, { "description": "the ID of the ovs provider", "length": 255, @@ -148271,43 +160359,56 @@ "related": "configureOvsElement", "required": true, "type": "uuid" + }, + { + "description": "Enabled/Disabled the service provider", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" } ], "related": "", "response": [ + {}, { - "description": "the id of the ovs", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the id of the ovs", + "name": "id", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { @@ -148315,23 +160416,17 @@ "name": "enabled", "type": "boolean" }, - {}, - { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", - "type": "string" - }, { - "description": "the project name of the address", - "name": "project", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, + {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -148340,48 +160435,41 @@ "name": "listSystemVmsUsageHistory", "params": [ { - "description": "List by keyword", + "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, - { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, { "description": "the IDs of the system VMs, mutually exclusive with id.", "length": 255, "name": "ids", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "required": false, "type": "list" }, { - "description": "the ID of the system VM.", + "description": "", "length": 255, - "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "name", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "", + "description": "the ID of the system VM.", "length": 255, - "name": "page", + "name": "id", + "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", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", @@ -148390,10 +160478,17 @@ "required": false, "type": "date" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -148401,36 +160496,36 @@ "related": "", "response": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" } ], "since": "4.18.0" @@ -148450,14 +160545,15 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -148466,11 +160562,10 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, - {}, {} ] }, @@ -148480,11 +160575,11 @@ "name": "createFirewallRule", "params": [ { - "description": "the starting port of firewall rule", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "name": "protocol", + "required": true, + "type": "string" }, { "description": "error code for this icmp message", @@ -148494,19 +160589,18 @@ "type": "integer" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "description": "type of firewallrule: system/user", "length": 255, - "name": "protocol", - "required": true, + "name": "type", + "required": false, "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "type of the ICMP message being sent", "length": 255, - "name": "fordisplay", + "name": "icmptype", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { "description": "the IP address id of the port forwarding rule", @@ -148517,16 +160611,9 @@ "type": "uuid" }, { - "description": "type of firewallrule: system/user", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "type of the ICMP message being sent", + "description": "the starting port of firewall rule", "length": 255, - "name": "icmptype", + "name": "startport", "required": false, "type": "integer" }, @@ -148543,28 +160630,32 @@ "name": "cidrlist", "required": false, "type": "list" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "updateEgressFirewallRule", "response": [ { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { @@ -148573,34 +160664,34 @@ "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, + {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, - {}, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { @@ -148608,8 +160699,8 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -148618,79 +160709,83 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "error code for this icmp message", "name": "icmpcode", "type": "integer" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -148699,70 +160794,70 @@ "name": "createVolume", "params": [ { - "description": "the ID of the availability zone", + "description": "an optional field, whether to display the volume to the end user or not.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "displayvolume", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Arbitrary volume size", + "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", "length": 255, - "name": "size", + "name": "virtualmachineid", + "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", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "max iops", "length": 255, - "name": "account", + "name": "maxiops", "required": false, - "type": "string" + "type": "long" }, { - "description": "an optional field, whether to display the volume to the end user or not.", + "description": "the project associated with the volume. Mutually exclusive with account parameter", "length": 255, - "name": "displayvolume", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "Arbitrary volume size", "length": 255, - "name": "name", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "description": "the ID of the availability zone", "length": 255, - "name": "snapshotid", - "related": "listSnapshots", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "snapshotid", + "related": "listSnapshots", "required": false, "type": "uuid" }, @@ -148773,13 +160868,6 @@ "required": false, "type": "long" }, - { - "description": "max iops", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" - }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -148788,116 +160876,190 @@ "type": "string" }, { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" + }, + { + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { "description": "IO requests write rate of the disk volume per the disk offering", @@ -148905,24 +161067,19 @@ "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { "description": "name of the disk offering", @@ -148930,44 +161087,49 @@ "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { "description": "the format of the disk encryption if applicable", @@ -148975,237 +161137,175 @@ "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, - {}, { "description": "the write (IO) of disk on the vm", "name": "diskiowrite", "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + {}, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { "description": "bytes read rate of the disk volume", @@ -149213,14 +161313,9 @@ "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" } ] }, @@ -149230,58 +161325,54 @@ "name": "listVMSnapshot", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the vm", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", + "name": "account", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "The ID of the VM snapshot", + "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.", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -149292,32 +161383,36 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", "length": 255, - "name": "account", + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "since": "4.9", + "type": "list" }, { - "description": "List by keyword", + "description": "state of the virtual machine snapshot", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "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.", + "description": "the ID of the vm", "length": 255, - "name": "listall", + "name": "virtualmachineid", + "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", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "lists snapshot by snapshot name or display name", + "description": "The ID of the VM snapshot", "length": 255, - "name": "name", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List resources by tags (key/value pairs)", @@ -149327,18 +161422,55 @@ "type": "map" }, { - "description": "state of the virtual machine snapshot", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "createVMSnapshot", "response": [ { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "VM Snapshot type", + "name": "type", + "type": "string" + }, + {}, + { + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "string" + }, + { + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -149346,18 +161478,43 @@ "name": "virtualmachinename", "type": "string" }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "the description of the vm snapshot", + "name": "description", + "type": "string" + }, + { + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -149366,73 +161523,67 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" }, { "description": "the project name of the vpn", @@ -149445,18 +161596,8 @@ "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -149464,61 +161605,15 @@ "name": "parent", "type": "string" }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, { "description": "the name of the vm snapshot", "name": "name", "type": "string" }, - { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", - "type": "string" - }, - { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" - }, { "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" - }, - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" } ], "since": "4.2.0" @@ -149529,10 +161624,10 @@ "name": "moveNetworkAclItem", "params": [ { - "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", + "description": "The ID of the network ACL rule that is being moved to a new position.", "length": 255, - "name": "previousaclruleid", - "required": false, + "name": "id", + "required": true, "type": "string" }, { @@ -149558,54 +161653,39 @@ "type": "string" }, { - "description": "The ID of the network ACL rule that is being moved to a new position.", + "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", "length": 255, - "name": "id", - "required": true, + "name": "previousaclruleid", + "required": false, "type": "string" } ], "related": "", "response": [ - { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, + {}, { "description": "the starting port of ACL's port range", "name": "startport", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, - {}, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { @@ -149613,11 +161693,6 @@ "name": "jobid", "type": "string" }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", @@ -149628,18 +161703,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -149648,8 +161723,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -149658,8 +161733,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -149668,53 +161743,73 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, + {}, { "description": "an explanation on why this ACL rule is being applied", "name": "reason", "type": "string" }, - {}, { - "description": "Number of the ACL Item", - "name": "number", + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "Number of the ACL Item", + "name": "number", "type": "integer" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" } ] }, @@ -149742,12 +161837,6 @@ ], "response": [ {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -149758,6 +161847,12 @@ "name": "jobstatus", "type": "integer" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -149770,13 +161865,6 @@ "isasync": false, "name": "listBaremetalDhcp", "params": [ - { - "description": "Type of DHCP device", - "length": 255, - "name": "dhcpservertype", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -149798,6 +161886,13 @@ "required": false, "type": "long" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -149807,9 +161902,9 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "Type of DHCP device", "length": 255, - "name": "keyword", + "name": "dhcpservertype", "required": false, "type": "string" } @@ -149826,14 +161921,10 @@ "name": "dhcpservertype", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "url", - "name": "url", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, {}, @@ -149842,15 +161933,19 @@ "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "url", + "name": "url", "type": "string" } ] @@ -149872,34 +161967,36 @@ "related": "cancelStorageMaintenance", "response": [ { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, + {}, + {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the overprovisionfactor for the storage pool", @@ -149907,23 +162004,33 @@ "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -149932,29 +162039,29 @@ "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the storage pool capabilities", @@ -149962,31 +162069,34 @@ "type": "map" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "the storage pool type", + "name": "type", + "type": "string" }, - {}, { "description": "the Pod name of the storage pool", "name": "podname", "type": "string" }, - {}, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -149994,8 +162104,8 @@ "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -150004,9 +162114,9 @@ "type": "boolean" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { "description": "the nfs mount options for the storage pool", @@ -150014,29 +162124,24 @@ "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" } ] }, @@ -150055,28 +162160,28 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.19.0" }, @@ -150095,18 +162200,23 @@ ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the list params the api accepts", "name": "params", "response": [ { - "description": "parameter type", - "name": "type", + "description": "comma separated related apis to get the parameter", + "name": "related", "type": "string" }, { - "description": "the name of the api parameter", - "name": "name", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { @@ -150115,25 +162225,25 @@ "type": "boolean" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "description of the api parameter", + "name": "description", "type": "string" }, {}, { - "description": "comma separated related apis to get the parameter", - "name": "related", - "type": "string" - }, - { - "description": "description of the api parameter", - "name": "description", + "description": "parameter type", + "name": "type", "type": "string" }, { "description": "length of the parameter", "name": "length", "type": "int" + }, + { + "description": "the name of the api parameter", + "name": "name", + "type": "string" } ], "type": "set" @@ -150143,69 +162253,64 @@ "name": "name", "type": "string" }, + { + "description": "comma separated related apis", + "name": "related", + "type": "string" + }, {}, { "description": "description of the api", "name": "description", "type": "string" }, + { + "description": "response field type", + "name": "type", + "type": "string" + }, + { + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" + }, { "description": "api response fields", "name": "response", "response": [ + { + "description": "response field type", + "name": "type", + "type": "string" + }, { "description": "api response fields", "name": "response", "type": "set" }, - { - "description": "the name of the api response field", - "name": "name", - "type": "string" - }, { "description": "description of the api response field", "name": "description", "type": "string" }, { - "description": "response field type", - "name": "type", + "description": "the name of the api response field", + "name": "name", "type": "string" } ], "type": "set" }, - { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "comma separated related apis", - "name": "related", - "type": "string" - }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if api is asynchronous", "name": "isasync", "type": "boolean" }, { - "description": "response field type", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.1.0" @@ -150225,6 +162330,11 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -150236,11 +162346,6 @@ "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -150254,28 +162359,14 @@ "isasync": true, "name": "createVMSnapshot", "params": [ - { - "description": "The description of the snapshot", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "The ID of the vm", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "required": true, "type": "uuid" }, - { - "description": "The display name of the snapshot", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "quiesce vm if true", "length": 255, @@ -150289,13 +162380,27 @@ "name": "snapshotmemory", "required": false, "type": "boolean" + }, + { + "description": "The description of the snapshot", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "The display name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, { @@ -150308,110 +162413,33 @@ "name": "project", "type": "string" }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", - "type": "string" - }, - {}, - {}, - { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the vm snapshot", - "name": "name", - "type": "string" - }, { "description": "the Zone name of the vm snapshot", "name": "zonename", "type": "string" }, - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - { - "description": "the parent ID of the vm snapshot", - "name": "parent", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -150420,23 +162448,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -150445,37 +162473,114 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + { + "description": "the parent ID of the vm snapshot", + "name": "parent", + "type": "string" + }, { "description": "indicates if this is current snapshot", "name": "current", "type": "boolean" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, + {}, { "description": "the parent displayName of the vm snapshot", "name": "parentName", "type": "string" }, + { + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" + }, + { + "description": "the description of the vm snapshot", + "name": "description", + "type": "string" + }, + { + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, { "description": "the project id of the vpn", "name": "projectid", "type": "string" }, + { + "description": "VM Snapshot type", + "name": "type", + "type": "string" + }, + { + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" + }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" + }, + {}, + { + "description": "the name of the vm snapshot", + "name": "name", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" } ], "since": "4.2.0" @@ -150500,23 +162605,23 @@ "name": "displaytext", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + {} ], "since": "4.2.0" }, @@ -150526,18 +162631,12 @@ "name": "listTungstenFabricTagType", "params": [ { - "description": "the uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "tagtypeuuid", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -150554,47 +162653,53 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric tag type", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "tagtypeuuid", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric tag type name", + "name": "name", + "type": "string" } ] }, @@ -150625,28 +162730,28 @@ "related": "", "response": [ { - "description": "the state of the extracted object", - "name": "state", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "", - "name": "resultstring", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { @@ -150655,43 +162760,39 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" }, { "description": "the percentage of the entity uploaded to the specified location", "name": "uploadpercentage", "type": "integer" }, + {}, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { @@ -150701,11 +162802,15 @@ }, {}, { - "description": "the name of the extracted object", - "name": "name", + "description": "", + "name": "resultstring", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.20.0" }, @@ -150714,21 +162819,6 @@ "isasync": false, "name": "listSSHKeyPairs", "params": [ - { - "description": "the ID of the ssh keypair", - "length": 255, - "name": "id", - "related": "listSSHKeyPairs", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -150737,11 +162827,11 @@ "type": "string" }, { - "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.", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "", @@ -150751,12 +162841,11 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "A key pair name to look for", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -150767,30 +162856,46 @@ "type": "uuid" }, { - "description": "", + "description": "the ID of the ssh keypair", "length": 255, - "name": "page", + "name": "id", + "related": "listSSHKeyPairs", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "A key pair name to look for", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "A public key fingerprint to look for", "length": 255, - "name": "account", + "name": "fingerprint", "required": false, "type": "string" }, { - "description": "A public key fingerprint to look for", + "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.", "length": 255, - "name": "fingerprint", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" } @@ -150798,14 +162903,24 @@ "related": "", "response": [ { - "description": "ID of the ssh keypair", - "name": "id", + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, {}, { - "description": "Name of the keypair", - "name": "name", + "description": "the domain id of the keypair owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the owner of the keypair", + "name": "account", "type": "string" }, { @@ -150819,8 +162934,8 @@ "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -150828,30 +162943,20 @@ "name": "fingerprint", "type": "string" }, - { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, {}, { - "description": "the owner of the keypair", - "name": "account", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" } ] @@ -150873,89 +162978,93 @@ "related": "", "response": [ { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, - {}, { - "description": "the storage pool type", - "name": "type", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", + "description": "the storage pool capabilities", + "name": "storagecapabilities", "type": "map" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { @@ -150963,49 +163072,45 @@ "name": "disksizetotal", "type": "long" }, + {}, { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "total IOPS currently in use", + "name": "usediops", "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { @@ -151013,14 +163118,15 @@ "name": "capacityiops", "type": "long" }, + {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { @@ -151028,15 +163134,24 @@ "name": "clusterid", "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage pool", + "name": "name", "type": "string" } ] @@ -151047,12 +163162,12 @@ "name": "updateSnapshotPolicy", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "an optional field, whether to the display the snapshot policy to the end user or not.", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" }, { "description": "the ID of the snapshot policy", @@ -151063,55 +163178,38 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the snapshot policy to the end user or not.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, - {}, { "description": "The list of zones in which snapshot backup is scheduled", "name": "zone", "type": "set" }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -151120,13 +163218,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -151135,13 +163233,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -151150,47 +163253,64 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, { "description": "the ID of the snapshot policy", "name": "id", "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The list of pools in which snapshot backup is scheduled", + "name": "storage", + "type": "set" }, + {}, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" }, + {}, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -151200,11 +163320,11 @@ "name": "quotaSummary", "params": [ { - "description": "Optional, Account Id for which statement needs to be generated", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -151214,103 +163334,103 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Optional, Account Id for which statement needs to be generated", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "Optional, to list all accounts irrespective of the quota activity", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "Optional, to list all accounts irrespective of the quota activity", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "account balance", - "name": "balance", - "type": "bigdecimal" - }, - { - "description": "start date", - "name": "startdate", - "type": "date" - }, { "description": "domain name", "name": "domain", "type": "string" }, - {}, { - "description": "domain id", - "name": "domainid", + "description": "currency", + "name": "currency", "type": "string" }, + { + "description": "account balance", + "name": "balance", + "type": "bigdecimal" + }, { "description": "account state", "name": "state", "type": "state" }, { - "description": "quota usage of this period", - "name": "quota", - "type": "bigdecimal" + "description": "account name", + "name": "account", + "type": "string" }, { - "description": "if the account has the quota config enabled", - "name": "quotaenabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "account name", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, + { + "description": "domain id", + "name": "domainid", + "type": "string" + }, { "description": "end date", "name": "enddate", "type": "date" }, + { + "description": "if the account has the quota config enabled", + "name": "quotaenabled", + "type": "boolean" + }, { "description": "account id", "name": "accountid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "quota usage of this period", + "name": "quota", + "type": "bigdecimal" }, { - "description": "currency", - "name": "currency", - "type": "string" + "description": "start date", + "name": "startdate", + "type": "date" } ], "since": "4.7.0" @@ -151332,8 +163452,13 @@ "related": "", "response": [ { - "description": "the account that executed the async command", - "name": "account", + "description": " the created date of the job", + "name": "created", + "type": "date" + }, + { + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, { @@ -151341,32 +163466,40 @@ "name": "jobinstanceid", "type": "string" }, - {}, - {}, { - "description": "the domain that executed the async command", - "name": "domainpath", + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "the result type", + "name": "jobresulttype", + "type": "string" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, + { + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" + }, { "description": "the result code for the job", "name": "jobresultcode", "type": "integer" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", + "type": "string" + }, + { + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -151379,49 +163512,36 @@ "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", - "type": "string" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "the async command executed", - "name": "cmd", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" + "description": "the account that executed the async command", + "name": "account", + "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the async command executed", + "name": "cmd", "type": "string" - }, - { - "description": " the completed date of the job", - "name": "completed", - "type": "date" - }, - { - "description": " the created date of the job", - "name": "created", - "type": "date" - }, - { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" } ] }, @@ -151431,47 +163551,63 @@ "name": "registerNetscalerControlCenter", "params": [ { - "description": "Credentials to reach netscaler controlcenter device", + "description": "URL of the netscaler controlcenter appliance.", "length": 255, - "name": "username", + "name": "ipaddress", "required": true, "type": "string" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "ipaddress", + "name": "password", "required": true, "type": "string" }, { "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "numretries", + "name": "username", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "password", + "name": "numretries", "required": true, - "type": "string" + "type": "integer" } ], "related": "addNetscalerLoadBalancer", "response": [ + {}, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, - {}, { "description": "device capacity", "name": "lbdevicecapacity", "type": "long" }, + {}, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "public IP of the NetScaler representing GSLB site", "name": "gslbproviderpublicip", @@ -151483,70 +163619,54 @@ "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, - {}, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, { "description": "the private interface of the load balancer", "name": "privateinterface", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, - { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "device state", + "name": "lbdevicestate", + "type": "string" }, { "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", "name": "podids", "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" } ] }, @@ -151556,67 +163676,62 @@ "name": "createCounter", "params": [ { - "description": "Name of the counter.", + "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, - "name": "name", + "name": "value", "required": true, "type": "string" }, { - "description": "Source of the counter.", + "description": "Network provider of the counter.", "length": 255, - "name": "source", + "name": "provider", "required": true, + "since": "4.18.0", "type": "string" }, { - "description": "Value of the counter e.g. oid in case of snmp.", + "description": "Source of the counter.", "length": 255, - "name": "value", + "name": "source", "required": true, "type": "string" }, { - "description": "Network provider of the counter.", + "description": "Name of the counter.", "length": 255, - "name": "provider", + "name": "name", "required": true, - "since": "4.18.0", "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Source of the counter.", + "name": "source", + "type": "string" }, + {}, { "description": "Name of the counter.", "name": "name", "type": "string" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Source of the counter.", - "name": "source", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, {}, { - "description": "the id of the Counter", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { @@ -151625,9 +163740,14 @@ "type": "string" }, { - "description": "Provider of the counter.", - "name": "provider", + "description": "the id of the Counter", + "name": "id", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -151639,22 +163759,22 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Event Type", + "name": "name", "type": "string" }, { - "description": "Event Type", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} + } ] }, { @@ -151663,7 +163783,7 @@ "name": "prepareForShutdown", "params": [ { - "description": "the uuid of the management server", + "description": "the id of the management server", "length": 255, "name": "managementserverid", "related": "", @@ -151673,11 +163793,20 @@ ], "related": "", "response": [ - {}, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "string" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "The host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" }, { "description": "Indicates whether CloudStack is ready to shutdown", @@ -151685,26 +163814,37 @@ "type": "boolean" }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "The number of host agents this management server is responsible for", + "name": "agentscount", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" + }, + { + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + {}, + {} ], "since": "4.19.0" }, @@ -151714,89 +163854,101 @@ "name": "addCluster", "params": [ { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", + "description": "the URL", "length": 255, - "name": "hypervisor", - "required": true, + "name": "url", + "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "allocationstate", + "name": "vsmpassword", "required": false, "type": "string" }, { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", "length": 255, - "name": "arch", + "name": "publicvswitchtype", "required": false, - "since": "4.20", "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "the Pod ID for the host", "length": 255, - "name": "vsmpassword", - "required": false, - "type": "string" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the cluster name", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "clustername", + "name": "clustertype", "required": true, "type": "string" }, { - "description": "the username for the VSM associated with this cluster", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "vsmusername", + "name": "publicvswitchname", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "the username for the cluster", "length": 255, - "name": "password", + "name": "username", "required": false, "type": "string" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "the password for the host", "length": 255, - "name": "vsmipaddress", + "name": "password", "required": false, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "clustertype", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the URL", + "description": "Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].=. Example: externaldetails[0].endpoint.url=https://example.com", "length": 255, - "name": "url", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "the Zone ID for the cluster", "length": 255, - "name": "publicvswitchname", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "UUID of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the username for the cluster", + "description": "comma separated list of storage access groups for the hosts in the cluster", "length": 255, - "name": "username", + "name": "storageaccessgroups", "required": false, - "type": "string" + "since": "4.21.0", + "type": "list" }, { "description": "Ovm3 native pooling enabled for cluster", @@ -151806,17 +163958,17 @@ "type": "string" }, { - "description": "the Pod ID for the host", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", "length": 255, - "name": "guestvswitchname", + "name": "guestvswitchtype", "required": false, "type": "string" }, @@ -151828,60 +163980,74 @@ "type": "string" }, { - "description": "the Zone ID for the cluster", + "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "ovm3cluster", + "required": false, + "type": "string" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "the username for the VSM associated with this cluster", "length": 255, - "name": "ovm3cluster", + "name": "vsmusername", "required": false, "type": "string" }, { - "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "publicvswitchtype", + "name": "vsmipaddress", "required": false, "type": "string" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "guestvswitchtype", + "name": "guestvswitchname", "required": false, "type": "string" + }, + { + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { @@ -151889,30 +164055,56 @@ "name": "managedstate", "type": "string" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, { "description": "The cpu overcommit ratio of the cluster", "name": "cpuovercommitratio", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", "type": "string" }, { @@ -151920,108 +164112,107 @@ "name": "capacity", "response": [ { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Pod name", - "name": "podname", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity name", + "name": "name", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone name", + "name": "zonename", "type": "string" } ], "type": "list" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" }, - {}, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -152040,6 +164231,11 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -152047,20 +164243,15 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -152070,209 +164261,321 @@ "name": "removeNicFromVirtualMachine", "params": [ { - "description": "Virtual Machine ID", + "description": "NIC ID", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "nicid", + "related": "", "required": true, "type": "uuid" }, { - "description": "NIC ID", + "description": "Virtual Machine ID", "length": 255, - "name": "nicid", - "related": "", + "name": "virtualmachineid", + "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", "required": true, "type": "uuid" } ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances,importVm", "response": [ { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + {}, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { @@ -152280,8 +164583,13 @@ "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -152290,57 +164598,124 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -152352,16 +164727,6 @@ "name": "resourcetype", "type": "string" }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -152373,18 +164738,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -152393,58 +164758,93 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -152452,6 +164852,11 @@ "name": "startport", "type": "integer" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -152462,164 +164867,62 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" } ], "type": "set" @@ -152627,192 +164930,252 @@ ], "type": "set" }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, { "description": "OS name of the vm", "name": "osdisplayname", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, {}, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -152821,23 +165184,43 @@ "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { @@ -152846,89 +165229,98 @@ "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, - {}, { "description": "NICs of the VNF appliance", "name": "vnfnics", "type": "list" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -152936,253 +165328,112 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, { "description": "the VM's primary IP address", "name": "ipaddress", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - {}, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, { "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" } ] }, @@ -153192,26 +165443,26 @@ "name": "listDedicatedHosts", "params": [ { - "description": "list dedicated hosts by affinity group", + "description": "the ID of the domain associated with the host", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "the name of the account associated with the host. Must be used with domainId.", @@ -153228,10 +165479,10 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the host", + "description": "list dedicated hosts by affinity group", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "affinitygroupid", + "related": "", "required": false, "type": "uuid" }, @@ -153247,13 +165498,14 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID of the host", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { @@ -153261,30 +165513,29 @@ "name": "affinitygroupid", "type": "string" }, - {}, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, { "description": "the ID of the host", "name": "hostid", "type": "string" }, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the host", "name": "hostname", "type": "string" }, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, {} @@ -153296,40 +165547,40 @@ "name": "getUploadParamsForIso", "params": [ { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "bootable", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "account", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "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", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "ostypeid", - "related": "", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "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 \"{}\", not including the double quotes. In this 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.", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "checksum", - "required": false, + "name": "format", + "required": true, "type": "string" }, { @@ -153348,52 +165599,61 @@ "type": "string" }, { - "description": "true if you want this ISO to be featured", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "isfeatured", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "Upload volume/template/iso for the project", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "isextractable", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "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 \"{}\", not including the double quotes. In this 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.", + "length": 255, + "name": "checksum", "required": false, "type": "string" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "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", "length": 255, - "name": "ispublic", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" } ], "related": "", "response": [ - {}, + { + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" + }, + { + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" + }, { "description": "signature to be sent in the POST request.", "name": "signature", @@ -153401,35 +165661,26 @@ }, {}, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, { "description": "POST url to upload the file to", "name": "postURL", "type": "url" }, + { + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.13" }, @@ -153438,6 +165689,13 @@ "isasync": true, "name": "getDiagnosticsData", "params": [ + { + "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", + "length": 255, + "name": "files", + "required": false, + "type": "list" + }, { "description": "The ID of the system VM instance to retrieve diagnostics data files from", "length": 255, @@ -153445,17 +165703,16 @@ "related": "", "required": true, "type": "uuid" - }, - { - "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", - "length": 255, - "name": "files", - "required": false, - "type": "list" } ], "related": "", "response": [ + { + "description": "Storage URL to download retrieve diagnostics data files", + "name": "url", + "type": "string" + }, + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -153466,13 +165723,7 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", - "type": "string" - }, - {} + } ], "since": "4.14.0.0" }, @@ -153481,14 +165732,6 @@ "isasync": true, "name": "deleteAutoScaleVmGroup", "params": [ - { - "description": "true if all VMs have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.18.0", - "type": "boolean" - }, { "description": "the ID of the autoscale group", "length": 255, @@ -153496,19 +165739,22 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "true if all VMs have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.18.0", + "type": "boolean" } ], "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -153517,9 +165763,14 @@ "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -153529,33 +165780,33 @@ "name": "listPaloAltoFirewalls", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Palo Alto firewall device ID", @@ -153569,67 +165820,67 @@ "related": "", "response": [ { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, - { - "description": "device state", - "name": "fwdevicestate", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "device name", - "name": "fwdevicename", - "type": "string" - }, { "description": "device capacity", "name": "fwdevicecapacity", "type": "long" }, + { + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" + }, + { + "description": "device state", + "name": "fwdevicestate", + "type": "string" + }, { "description": "the management IP address of the external firewall", "name": "ipaddress", "type": "string" }, - {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { "description": "the username that's used to log in to the external firewall", "name": "username", @@ -153641,23 +165892,23 @@ "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" } ] @@ -153667,21 +165918,6 @@ "isasync": true, "name": "updateLoadBalancerRule", "params": [ - { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": false, - "type": "string" - }, { "description": "the ID of the load balancer rule to update", "length": 255, @@ -153691,11 +165927,17 @@ "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the name of the load balancer rule", "length": 255, - "name": "customid", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", "required": false, - "since": "4.4", "type": "string" }, { @@ -153705,6 +165947,14 @@ "required": false, "type": "string" }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "the description of the load balancer rule", "length": 4096, @@ -153713,33 +165963,35 @@ "type": "string" }, { - "description": "the name of the load balancer rule", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "name", + "name": "customid", "required": false, + "since": "4.4", "type": "string" } ], "related": "listLoadBalancerRules", "response": [ { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, + {}, { - "description": "the public port", - "name": "publicport", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -153748,24 +166000,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { @@ -153773,97 +166014,92 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, + {}, { - "description": "the state of the rule", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, - {}, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { @@ -153871,34 +166107,49 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, { "description": "the protocol of the loadbalanacer rule", "name": "protocol", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", "type": "string" } ] @@ -153935,54 +166186,93 @@ "related": "listAccounts", "response": [ { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the total number of cpu cores the account can own", "name": "cpulimit", "type": "string" }, - {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { @@ -153991,48 +166281,73 @@ "type": "integer" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", + "name": "apikeyaccess", + "type": "apikeyaccess" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", + "description": "the list of acl groups that account belongs to", + "name": "groups", "type": "list" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -154041,28 +166356,18 @@ "type": "long" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", - "name": "apikeyaccess", - "type": "apikeyaccess" + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { @@ -154071,132 +166376,119 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, + {}, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -154205,73 +166497,78 @@ "type": "apikeyaccess" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user ID", - "name": "id", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "true if user has two factor authentication is mandated", "name": "is2famandated", "type": "boolean" }, { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -154280,103 +166577,132 @@ "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" } ], "type": "list" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, - {}, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" } ] }, @@ -154411,29 +166737,69 @@ ], "response": [ {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, + } + ], + "since": "4.19.1" + }, + { + "description": "Deletes a GPU card definition from the system", + "isasync": false, + "name": "deleteGpuCard", + "params": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + "description": "the ID of the GPU card", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], - "since": "4.19.1" + "since": "4.21.0" }, { "description": "Deletes a network", @@ -154457,27 +166823,27 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -154498,19 +166864,24 @@ "related": "", "response": [ { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { @@ -154519,45 +166890,126 @@ "type": "date" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, { "description": "the cluster ID of the host", "name": "clusterid", "type": "string" }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -154567,8 +167019,13 @@ "name": "vgpu", "response": [ { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -154576,35 +167033,30 @@ "name": "maxresolutionx", "type": "long" }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, { "description": "Maximum Y resolution per display", "name": "maxresolutiony", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { "description": "Maximum no. of vgpu per gpu card (pgpu)", "name": "maxvgpuperpgpu", "type": "long" }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, { "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", "name": "remainingcapacity", "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" } ], "type": "list" @@ -154618,44 +167070,39 @@ "type": "list" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the host type", - "name": "type", - "type": "type" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { "description": "the cluster type of the cluster that host belongs to", @@ -154663,69 +167110,54 @@ "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the host version", - "name": "version", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { "description": "the incoming network traffic on the host", @@ -154733,54 +167165,48 @@ "type": "long" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the name of the host", + "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the cpu average load on the host", "name": "cpuloadaverage", "type": "double" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { "description": "true if the host is disconnected. False otherwise.", "name": "disconnected", "type": "date" }, - {}, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, { "description": "the date and time the host was created", "name": "created", "type": "date" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { @@ -154789,48 +167215,34 @@ "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, + {}, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, { "description": "the host HA information information", "name": "hostha", "type": "hostharesponse" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone name of the host", - "name": "zonename", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { @@ -154839,54 +167251,59 @@ "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" } ] }, @@ -154907,19 +167324,19 @@ "related": "", "response": [ { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { "description": "the project id of the Kubernetes cluster", @@ -154927,29 +167344,25 @@ "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, + {}, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { "description": "the account associated with the Kubernetes cluster", @@ -154957,30 +167370,14 @@ "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" - }, - { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" - }, - {}, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { "description": "the project name of the Kubernetes cluster", @@ -154992,80 +167389,105 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + }, { "description": "the ID of the Kubernetes version for the Kubernetes cluster", "name": "kubernetesversionid", "type": "string" }, + {}, { "description": "the ID of the network of the Kubernetes cluster", "name": "networkid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", + "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", + "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, + { + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { @@ -155074,28 +167496,73 @@ "type": "clustertype" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" } ] @@ -155105,14 +167572,6 @@ "isasync": true, "name": "deleteProject", "params": [ - { - "description": "id of the project to be deleted", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "true if all project resources have to be cleaned up, false otherwise", "length": 255, @@ -155120,30 +167579,38 @@ "required": false, "since": "4.16.0", "type": "boolean" + }, + { + "description": "id of the project to be deleted", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -155154,11 +167621,11 @@ "name": "listSharedFileSystemProviders", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -155168,32 +167635,32 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - { - "description": "the name of the shared filesystem provider", - "name": "name", - "type": "string" - }, - {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the name of the shared filesystem provider", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ], "since": "4.20.0" }, @@ -155213,6 +167680,12 @@ ], "related": "listTemplatePermissions,listIsoPermissions", "response": [ + { + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" + }, + {}, { "description": "true if this template is a public template, false otherwise", "name": "ispublic", @@ -155224,32 +167697,26 @@ "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" + }, + {} ] }, { @@ -155258,37 +167725,24 @@ "name": "addNetscalerLoadBalancer", "params": [ { - "description": "public IP of the site", - "length": 255, - "name": "gslbproviderpublicip", - "required": false, - "type": "string" - }, - { - "description": "Credentials to reach netscaler load balancer device", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "description": "public IP of the site", "length": 255, - "name": "isexclusivegslbprovider", + "name": "gslbproviderpublicip", "required": false, - "type": "boolean" - }, - { - "description": "Credentials to reach netscaler load balancer device", - "length": 255, - "name": "password", - "required": true, "type": "string" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "description": "URL of the netscaler load balancer appliance.", "length": 255, - "name": "networkdevicetype", + "name": "url", "required": true, "type": "string" }, @@ -155300,19 +167754,18 @@ "type": "string" }, { - "description": "URL of the netscaler load balancer appliance.", + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", "length": 255, - "name": "url", + "name": "networkdevicetype", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { "description": "true if NetScaler device being added is for providing GSLB service", @@ -155320,13 +167773,32 @@ "name": "gslbprovider", "required": false, "type": "boolean" + }, + { + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "length": 255, + "name": "isexclusivegslbprovider", + "required": false, + "type": "boolean" + }, + { + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "password", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "lbdevicename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -155335,59 +167807,49 @@ "type": "string" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, - {}, { "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", "name": "isexclusivegslbprovider", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "device name", - "name": "lbdevicename", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, + {}, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { @@ -155396,21 +167858,26 @@ "type": "boolean" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, - {} + {}, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" + } ] }, { @@ -155422,7 +167889,7 @@ "description": "ID of the VM", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "required": true, "type": "uuid" } @@ -155430,31 +167897,46 @@ "related": "", "response": [ { - "description": "the interval type of the backup schedule", - "name": "intervaltype", - "type": "intervaltype" + "description": "ID of the backup schedule.", + "name": "id", + "type": "string" }, - {}, { - "description": "the time zone of the backup schedule", - "name": "timezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "maximum number of backups retained", + "name": "maxbackups", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "time the backup is scheduled to be taken.", "name": "schedule", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "quiesce the instance before checkpointing the disks for backup", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the time zone of the backup schedule", + "name": "timezone", + "type": "string" }, { "description": "ID of the VM", @@ -155462,9 +167944,9 @@ "type": "string" }, { - "description": "name of the VM", - "name": "virtualmachinename", - "type": "string" + "description": "the interval type of the backup schedule", + "name": "intervaltype", + "type": "intervaltype" } ], "since": "4.14.0" @@ -155474,6 +167956,14 @@ "isasync": true, "name": "restoreVolumeFromBackupAndAttachToVM", "params": [ + { + "description": "ID of the VM backup", + "length": 255, + "name": "backupid", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "ID of the volume backed up", "length": 255, @@ -155485,42 +167975,34 @@ "description": "id of the VM where to attach the restored volume", "length": 255, "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "ID of the VM backup", - "length": 255, - "name": "backupid", - "related": "", + "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", "required": true, "type": "uuid" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.14.0" }, @@ -155530,9 +168012,10 @@ "name": "removeNetworkPermissions", "params": [ { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accounts", + "name": "projectids", + "related": "", "required": false, "type": "list" }, @@ -155545,10 +168028,9 @@ "type": "list" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "", + "name": "accounts", "required": false, "type": "list" }, @@ -155563,25 +168045,25 @@ ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ], @@ -155610,28 +168092,28 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -155646,20 +168128,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the Physical Network ID", "length": 255, @@ -155674,40 +168142,54 @@ "name": "id", "required": false, "type": "long" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "device id of ", - "name": "id", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "url", "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -155728,28 +168210,13 @@ "related": "", "response": [ { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { @@ -155758,24 +168225,19 @@ "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the user firstname", - "name": "firstname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -155784,19 +168246,14 @@ "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -155804,15 +168261,20 @@ "type": "resourceiconresponse" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user ID", + "name": "id", "type": "string" }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, { "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", "name": "apikeyaccess", @@ -155820,28 +168282,38 @@ }, {}, { - "description": "the user name", - "name": "username", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -155849,20 +168321,30 @@ "name": "domain", "type": "string" }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, { "description": "the domain ID of the user", "name": "domainid", "type": "string" }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, { "description": "true if user has two factor authentication enabled", "name": "is2faenabled", "type": "boolean" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, @@ -155872,26 +168354,27 @@ "name": "listLoadBalancerRules", "params": [ { - "description": "the name of the load balancer rule", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "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.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list by network ID the rule belongs to", @@ -155902,70 +168385,69 @@ "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the public IP address ID of the load balancer rule", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "the name of the load balancer rule", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the availability zone ID", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "virtualmachineid", + "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", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "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.", "length": 255, - "name": "tags", + "name": "listall", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the availability zone ID", "length": 255, - "name": "projectid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -155977,26 +168459,26 @@ "type": "integer" }, { - "description": "the public IP address ID of the load balancer rule", + "description": "the ID of the load balancer rule", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "id", + "related": "", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -156005,39 +168487,43 @@ "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, - {}, { "description": "the load balancer rule ID", "name": "id", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -156046,28 +168532,29 @@ "type": "boolean" }, { - "description": "the state of the rule", - "name": "state", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, + {}, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { @@ -156076,8 +168563,8 @@ "type": "integer" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { @@ -156086,33 +168573,23 @@ "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - {}, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the private port", + "name": "privateport", "type": "string" }, + {}, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -156121,13 +168598,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -156136,41 +168613,46 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" } ] @@ -156181,30 +168663,30 @@ "name": "createManagementNetworkIpRange", "params": [ { - "description": "The ending IP address.", + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", "length": 255, - "name": "endip", + "name": "vlan", "required": false, "type": "string" }, { - "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", + "description": "The gateway for the management network.", "length": 255, - "name": "vlan", - "required": false, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "The starting IP address.", + "description": "The netmask for the management network.", "length": 255, - "name": "startip", + "name": "netmask", "required": true, "type": "string" }, { - "description": "The gateway for the management network.", + "description": "The starting IP address.", "length": 255, - "name": "gateway", + "name": "startip", "required": true, "type": "string" }, @@ -156216,10 +168698,10 @@ "type": "boolean" }, { - "description": "The netmask for the management network.", + "description": "The ending IP address.", "length": 255, - "name": "netmask", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { @@ -156233,30 +168715,20 @@ ], "related": "", "response": [ - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, { "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", "name": "endip", "type": "list" }, { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -156264,14 +168736,14 @@ "type": "integer" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" }, {}, { @@ -156280,90 +168752,67 @@ "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the ending IP for the range", - "name": "endip", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" - }, - {}, - { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ { "description": "the Zone name", "name": "zonename", "type": "string" }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, { "description": "the Cluster name", "name": "clustername", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -156371,48 +168820,91 @@ "name": "type", "type": "short" }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, { "description": "the capacity currently in allocated", "name": "capacityallocated", "type": "long" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", "type": "string" } ], "type": "list" }, + {}, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" } ], "since": "4.11.0.0" @@ -156423,49 +168915,49 @@ "name": "listCiscoNexusVSMs", "params": [ { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clusterid", + "related": "", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { "description": "device id of the Cisco N1KV VSM device", @@ -156473,18 +168965,24 @@ "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", "type": "int" }, + { + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", + "type": "string" + }, { "description": "device state", "name": "vsmdevicestate", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { @@ -156493,46 +168991,40 @@ "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", "type": "int" }, - { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" - }, - { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "device name", + "name": "vsmdevicename", + "type": "string" + }, + { + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", + "type": "string" } ] }, @@ -156542,10 +169034,17 @@ "name": "addVpnUser", "params": [ { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "username for the vpn user", "length": 255, - "name": "account", - "required": false, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "password for the username", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { @@ -156556,13 +169055,6 @@ "required": false, "type": "uuid" }, - { - "description": "username for the vpn user", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, @@ -156572,10 +169064,10 @@ "type": "uuid" }, { - "description": "password for the username", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "password", - "required": true, + "name": "account", + "required": false, "type": "string" } ], @@ -156587,39 +169079,40 @@ "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, + {}, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the username of the vpn user", - "name": "username", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the vpn userID", + "name": "id", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -156628,14 +169121,13 @@ "type": "integer" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the vpn userID", - "name": "id", + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" } ] @@ -156663,13 +169155,6 @@ } ], "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -156680,10 +169165,17 @@ "name": "success", "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.14.0" @@ -156694,33 +169186,33 @@ "name": "deleteProjectRolePermission", "params": [ { - "description": "ID of the project role permission to be deleted", + "description": "ID of the project where the project role permission is to be deleted", "length": 255, - "name": "id", + "name": "projectid", "related": "", "required": true, "type": "uuid" }, { - "description": "ID of the project where the project role permission is to be deleted", + "description": "ID of the project role permission to be deleted", "length": 255, - "name": "projectid", + "name": "id", "related": "", "required": true, "type": "uuid" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, {}, { @@ -156729,9 +169221,9 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "4.15.0" @@ -156741,13 +169233,6 @@ "isasync": false, "name": "updateQuarantinedIp", "params": [ - { - "description": "The date when the quarantine will no longer be active.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" - }, { "description": "The ID of the public IP address in active quarantine.", "length": 255, @@ -156756,6 +169241,13 @@ "required": false, "type": "uuid" }, + { + "description": "The date when the quarantine will no longer be active.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" + }, { "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", "length": 255, @@ -156766,48 +169258,48 @@ ], "related": "", "response": [ - {}, - { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" - }, { "description": "Account name of the previous public IP address owner.", "name": "previousownername", "type": "string" }, { - "description": "ID of the quarantine process.", - "name": "id", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "The public IP address in quarantine.", "name": "ipaddress", "type": "string" }, + {}, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the quarantine process.", + "name": "id", + "type": "string" }, + { + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" + }, + {}, { "description": "The reason for removing the IP from quarantine prematurely.", "name": "removalreason", @@ -156819,9 +169311,9 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" } ], "since": "4.19" @@ -156832,11 +169324,11 @@ "name": "updateVnfTemplate", "params": [ { - "description": "sort key of the template, integer", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "sortkey", + "name": "isrouting", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "the display text of the image", @@ -156846,89 +169338,91 @@ "type": "string" }, { - "description": "the name of the image file", + "description": "the tag for this template.", "length": 255, - "name": "name", + "name": "templatetag", "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "details", + "name": "isdynamicallyscalable", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "cleanupvnfnics", + "name": "templatetype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "passwordenabled", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "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)", + "description": "the ID of the image file", "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", "length": 255, - "name": "isdynamicallyscalable", + "name": "cleanupvnfdetails", "required": false, "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "requireshvm", + "name": "cleanupvnfnics", "required": false, "type": "boolean" }, { - "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", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "vnfnics", + "name": "bootable", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", "length": 255, - "name": "cleanupvnfdetails", + "name": "vnfdetails", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "indicates that the template can be used for deployment of CKS clusters", "length": 255, - "name": "arch", + "name": "forcks", "required": false, - "since": "4.20", - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "the name of the image file", "length": 255, - "name": "templatetype", + "name": "name", "required": false, "type": "string" }, { - "description": "the format for the image", + "description": "sort key of the template, integer", "length": 255, - "name": "format", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of the OS type that best represents the OS of this image.", @@ -156939,100 +169433,125 @@ "type": "uuid" }, { - "description": "the tag for this template.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "templatetag", + "name": "sshkeyenabled", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "description": "the ID of the image file", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "id", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the format for the image", "length": 255, - "name": "sshkeyenabled", + "name": "format", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "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)", "length": 255, - "name": "vnfdetails", + "name": "cleanupdetails", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "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.", "length": 255, - "name": "isrouting", + "name": "forceupdateostype", "required": false, + "since": "4.21", "type": "boolean" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "bootable", + "name": "requireshvm", "required": false, "type": "boolean" + }, + { + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "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", + "length": 255, + "name": "vnfnics", + "required": false, + "type": "map" } ], - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "response": [ { - "description": "the template ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "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", + "name": "userdataparams", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, + {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { @@ -157041,29 +169560,14 @@ "type": "long" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { "description": "the userdata override policy with the userdata provided while deploying VM", @@ -157071,14 +169575,9 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { "description": "the name of userdata linked to this template", @@ -157086,24 +169585,19 @@ "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { "description": "the format of the template.", @@ -157111,93 +169605,57 @@ "type": "imageformat" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the template name", - "name": "name", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "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", - "name": "userdataparams", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, - {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -157206,8 +169664,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -157221,48 +169684,77 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, - {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if the entity/resource has annotations", @@ -157270,58 +169762,90 @@ "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the project name of the template", + "name": "project", "type": "string" }, + {}, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { "description": "the id of userdata linked to this template", "name": "userdataid", "type": "string" }, + {}, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" } ], @@ -157332,21 +169856,6 @@ "isasync": true, "name": "updateVPCOffering", "params": [ - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, - "type": "string" - }, - { - "description": "the id of the VPC offering", - "length": 255, - "name": "id", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" - }, { "description": "sort key of the VPC offering, integer", "length": 255, @@ -157355,18 +169864,18 @@ "type": "integer" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, - "since": "4.13", "type": "string" }, { - "description": "the display text of the VPC offering", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "displaytext", + "name": "zoneid", "required": false, + "since": "4.13", "type": "string" }, { @@ -157376,44 +169885,34 @@ "required": false, "type": "string" }, + { + "description": "the id of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" + }, { "description": "the name of the VPC offering", "length": 255, "name": "name", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, - { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" - }, - { - "description": "an alternate display text of the vpc offering.", + "description": "the display text of the VPC offering", + "length": 255, "name": "displaytext", + "required": false, "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the vpc offering", - "name": "name", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { @@ -157423,67 +169922,42 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - {}, - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, { "description": "the list of supported services", "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", "type": "boolean" } ], @@ -157495,23 +169969,43 @@ "type": "string" }, { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability value", - "name": "value", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the capability name", + "description": "the provider name", "name": "name", "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" @@ -157520,56 +170014,133 @@ "type": "list" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "state of the vpc offering. Can be Disabled/Enabled", "name": "state", "type": "string" }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, { "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", "name": "distributedvpcrouter", "type": "boolean" }, + { + "description": "the name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" + }, { "description": "true if vpc offering can be used by NSX networks only", "name": "fornsx", "type": "boolean" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + } + ] + }, + { + "description": "Lists user two factor authenticator providers", + "isasync": false, + "name": "listUserTwoFactorAuthenticatorProviders", + "params": [ + { + "description": "List user two factor authenticator provider by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the user two factor authenticator provider name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the user two factor authenticator provider", + "name": "description", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] + }, + {} + ], + "since": "4.18.0" }, { - "description": "Lists authorized users who can used SAML SSO", + "description": "Lists extensions", "isasync": false, - "name": "listSamlAuthorization", + "name": "listExtensions", "params": [ + { + "description": "comma separated list of extension details requested, value can be a list of [all, resources, external, min]. When no parameters are passed, all the details are returned.", + "length": 255, + "name": "details", + "required": false, + "type": "list" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -157581,91 +170152,132 @@ "type": "string" }, { - "description": "User uuid", + "description": "", "length": 255, - "name": "userid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "Name of the extension", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "uuid of the extension", + "length": 255, + "name": "id", + "related": "listExtensions", + "required": false, + "type": "uuid" } ], "related": "", "response": [ + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the SAML authorization status", - "name": "status", - "type": "boolean" + "description": "Description of the extension", + "name": "description", + "type": "string" }, { - "description": "the authorized Identity Provider ID", - "name": "idpid", - "type": "string" + "description": "The details of the extension", + "name": "details", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Type of the extension", + "name": "type", "type": "string" }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, {}, {}, { - "description": "the user ID", - "name": "userid", + "description": "ID of the extension", + "name": "id", "type": "string" - } - ] - }, - { - "description": "Lists user two factor authenticator providers", - "isasync": false, - "name": "listUserTwoFactorAuthenticatorProviders", - "params": [ + }, + {}, { - "description": "List user two factor authenticator provider by name", - "length": 255, - "name": "name", - "required": false, + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, { - "description": "the description of the user two factor authenticator provider", - "name": "description", + "description": "The state of the extension", + "name": "state", + "type": "string" + }, + { + "description": "Name of the extension", + "name": "name", "type": "string" }, + { + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" + }, + { + "description": "the details of the resource map", + "name": "details", + "type": "map" + } + ], + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the user two factor authenticator provider name", - "name": "name", - "type": "string" + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" } ], - "since": "4.18.0" + "since": "4.21.0" }, { "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", @@ -157673,84 +170285,84 @@ "name": "scaleVirtualMachine", "params": [ { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "maxiops", + "name": "details", "required": false, - "since": "4.17", - "type": "long" - }, - { - "description": "the ID of the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "type": "map" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "miniops", + "name": "shrinkok", "required": false, "since": "4.17", - "type": "long" + "type": "boolean" }, { - "description": "Verify OK to Shrink", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "shrinkok", + "name": "automigrate", "required": false, "since": "4.17", "type": "boolean" }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "details", + "name": "miniops", "required": false, - "type": "map" + "since": "4.17", + "type": "long" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "automigrate", - "required": false, - "since": "4.17", - "type": "boolean" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "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", "required": true, "type": "uuid" + }, + { + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} + } ] }, { @@ -157759,12 +170371,12 @@ "name": "updateEgressFirewallRule", "params": [ { - "description": "the ID of the egress firewall rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -157775,20 +170387,20 @@ "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the egress firewall rule", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" }, { "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", @@ -157796,44 +170408,67 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, { "description": "error code for this icmp message", "name": "icmpcode", "type": "integer" }, - {}, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -157841,11 +170476,6 @@ "name": "key", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "tag value", "name": "value", @@ -157856,53 +170486,34 @@ "name": "domainid", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, + {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { "description": "the ID of the firewall rule", @@ -157910,8 +170521,8 @@ "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -157919,15 +170530,16 @@ "name": "startport", "type": "integer" }, + {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" } ], "since": "4.4" @@ -157938,14 +170550,16 @@ "name": "listOsCategories", "params": [ { - "description": "", + "description": "List available OS categories types for the zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "uuid" }, { - "description": "list os category by name", + "description": "List OS category by name", "length": 255, "name": "name", "required": false, @@ -157953,19 +170567,20 @@ "type": "string" }, { - "description": "list Os category by id", + "description": "List OS categories types available for given CPU architecture", "length": 255, - "name": "id", - "related": "listOsCategories", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "string" }, { - "description": "", + "description": "flag to display the resource image for the OS category", "length": 255, - "name": "pagesize", + "name": "showicon", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { "description": "List by keyword", @@ -157973,31 +170588,92 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List OS category by id", + "length": 255, + "name": "id", + "related": "listOsCategories", + "required": false, + "type": "uuid" + }, + { + "description": "List available OS categories by featured or not", + "length": 255, + "name": "isfeatured", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "List OS categories for which a VNF template is available", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "List OS categories for which an ISO is available", + "length": 255, + "name": "isiso", + "required": false, + "since": "4.21.0", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the ID of the OS category", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, {}, + {}, { "description": "the name of the OS category", "name": "name", "type": "string" }, + { + "description": "the ID of the OS category", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" + }, + { + "description": "Whether the OS category is featured", + "name": "isfeatured", + "type": "boolean" } ] }, @@ -158007,101 +170683,117 @@ "name": "listServiceOfferings", "params": [ { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "systemvmtype", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the CPU number that listed offerings must support", + "description": "Flag to indicate if the service offering supports GPU. If set to true, only service offerings that support GPU will be returned.", "length": 255, - "name": "cpunumber", + "name": "gpuenabled", "required": false, - "since": "4.15", - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "virtualmachineid", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importVm", + "name": "storagetype", "required": false, - "type": "uuid" + "since": "4.19", + "type": "string" }, { - "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "since": "4.19", - "type": "string" + "type": "integer" }, { - "description": "listed offerings support root disk encryption", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "encryptroot", + "name": "cpunumber", "required": false, - "since": "4.18", - "type": "boolean" + "since": "4.15", + "type": "integer" }, { - "description": "is this a system vm offering", + "description": "The ID of the vGPU profile that listed offerings must support", "length": 255, - "name": "issystem", + "name": "vgpuprofileid", + "related": "", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "List by keyword", "length": 255, - "name": "storagetype", + "name": "keyword", "required": false, - "since": "4.19", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "projectid", - "related": "", + "name": "systemvmtype", + "required": false, + "type": "string" + }, + { + "description": "ID of the service offering", + "length": 255, + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "name of the service offering", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "listed offerings support root disk encryption", "length": 255, - "name": "keyword", + "name": "encryptroot", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "the CPU speed that listed offerings must support", + "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", "length": 255, - "name": "cpuspeed", + "name": "virtualmachineid", + "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", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", "required": false, - "since": "4.15", "type": "integer" }, { @@ -158114,9 +170806,17 @@ "type": "uuid" }, { - "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.", + "description": "the RAM memory that listed offering must support", "length": 255, - "name": "listall", + "name": "memory", + "required": false, + "since": "4.15", + "type": "integer" + }, + { + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", "required": false, "type": "boolean" }, @@ -158124,23 +170824,24 @@ "description": "The ID of the template that listed offerings must support", "length": 255, "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "required": false, "since": "4.20.0", "type": "uuid" }, { - "description": "", + "description": "name of the service offering", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "account", + "name": "state", "required": false, + "since": "4.19", "type": "string" }, { @@ -158152,58 +170853,60 @@ "type": "uuid" }, { - "description": "the RAM memory that listed offering must support", + "description": "the CPU speed that listed offerings must support", "length": 255, - "name": "memory", + "name": "cpuspeed", "required": false, "since": "4.15", "type": "integer" - }, - { - "description": "ID of the service offering", - "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" } ], "related": "updateServiceOffering", "response": [ + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, { "description": "true if disk offering uses custom iops, false otherwise", "name": "iscustomizediops", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "the memory in MB", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { "description": "true if virtual machine root disk will be encrypted on storage", @@ -158211,24 +170914,30 @@ "type": "boolean" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { "description": "the number of CPU", @@ -158236,64 +170945,94 @@ "type": "integer" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { "description": "the ID of the disk offering to which service offering is linked", @@ -158301,34 +171040,49 @@ "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "state of the service offering", + "name": "state", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" + }, + { + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", + "type": "boolean" }, { "description": "the host tag for the service offering", @@ -158336,13 +171090,19 @@ "type": "string" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { @@ -158351,101 +171111,94 @@ "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "is this a system vm offering", - "name": "issystem", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" - }, - {}, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" - }, - {}, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the memory in MB", + "name": "memory", "type": "integer" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" } ] }, @@ -158455,109 +171208,89 @@ "name": "importVm", "params": [ { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "the host name of the instance", + "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.", "length": 255, - "name": "hostname", + "name": "forcemstoimportvmfiles", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", "length": 255, - "name": "datacentername", + "name": "migrateallowed", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "description": "hypervisor type of the host", "length": 255, - "name": "clustername", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the network ID", + "description": "VM 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", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "forced", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the display name of the instance", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "displayname", + "name": "account", "required": false, "type": "string" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "the password for the host", "length": 255, - "name": "nicipaddresslist", + "name": "password", "required": false, - "type": "map" + "type": "string" }, { - "description": "Shared storage pool where disk is located", + "description": "the zone ID", "length": 255, - "name": "storageid", - "related": "", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", + "description": "Shared storage pool where disk is located", "length": 255, - "name": "existingvcenterid", + "name": "storageid", "related": "", "required": false, "type": "uuid" }, { - "description": "import instance for the project", + "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", "length": 255, - "name": "projectid", - "related": "", + "name": "clustername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", "length": 255, - "name": "convertinstancepoolid", - "related": "", + "name": "datacentername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", + "description": "used to specify the custom parameters.", "length": 255, - "name": "importinstancehostid", - "related": "", + "name": "details", "required": false, - "since": "4.19.2", - "type": "uuid" - }, - { - "description": "the name of the instance as it is known to the hypervisor", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "map" }, { - "description": "Host where local disk is located", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "hostid", - "related": "", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", "required": false, "type": "uuid" }, @@ -158569,11 +171302,11 @@ "type": "string" }, { - "description": "hypervisor type of the host", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "datadiskofferinglist", + "required": false, + "type": "map" }, { "description": "path of the disk image", @@ -158583,48 +171316,57 @@ "type": "string" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "import instance to the domain specified", "length": 255, - "name": "datadiskofferinglist", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", "length": 255, - "name": "templateid", - "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "existingvcenterid", + "related": "", "required": false, "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "account", + "name": "nicnetworklist", "required": false, - "type": "string" + "type": "map" }, { - "description": "the zone ID", + "description": "Source location for Import", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "importsource", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "Temp Path on external host for disk image copy", "length": 255, - "name": "nicnetworklist", + "name": "temppath", "required": false, - "type": "map" + "type": "string" }, { - "description": "VM 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", + "description": "the service offering for the virtual machine", "length": 255, - "name": "forced", + "name": "serviceofferingid", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" + }, + { + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", @@ -158634,111 +171376,210 @@ "type": "string" }, { - "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.", + "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", "length": 255, - "name": "vcenter", + "name": "importinstancehostid", + "related": "", "required": false, - "type": "string" + "since": "4.19.2", + "type": "uuid" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "the host name or IP address", "length": 255, - "name": "migrateallowed", + "name": "host", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "import instance to the domain specified", + "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "convertinstancehostid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the host name or IP address", + "description": "Host where local disk is located", "length": 255, - "name": "host", + "name": "hostid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Temp Path on external host for disk image copy", + "description": "the cluster ID", "length": 255, - "name": "temppath", - "required": false, - "type": "string" + "name": "clusterid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "Source location for Import", + "description": "import instance for the project", "length": 255, - "name": "importsource", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.", + "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", "length": 255, - "name": "convertinstancehostid", + "name": "convertinstancepoolid", "related": "", "required": false, "type": "uuid" }, { - "description": "the service offering for the virtual machine", + "description": "the display name of the instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "name": "displayname", + "required": false, + "type": "string" }, { - "description": "the password for the host", + "description": "the host name of the instance", "length": 255, - "name": "password", + "name": "hostname", "required": false, "type": "string" }, { - "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.", + "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.", "length": 255, - "name": "forcemstoimportvmfiles", + "name": "vcenter", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "used to specify the custom parameters.", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "details", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", "required": false, "type": "map" } ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances", "response": [ { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { @@ -158747,273 +171588,462 @@ "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" } ], "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -159023,14 +172053,24 @@ "name": "description", "type": "string" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the ending IP of the security group rule ", @@ -159038,14 +172078,14 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "security group name", @@ -159062,8 +172102,8 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -159072,71 +172112,158 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the project name of the group", "name": "project", @@ -159152,8 +172279,8 @@ "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -159162,13 +172289,33 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -159181,23 +172328,23 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -159211,144 +172358,32 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "set" @@ -159357,38 +172392,28 @@ "description": "the name of the security group", "name": "name", "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" } ], "type": "set" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -159396,74 +172421,23 @@ "name": "receivedbytes", "type": "long" }, - {}, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -159471,285 +172445,99 @@ "name": "key", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - {}, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + {}, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -159758,53 +172546,78 @@ "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { @@ -159821,34 +172634,23 @@ "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "description": "The ID of the load balancer rule", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, - "name": "id", + "name": "loadbalancerrulelist", "related": "", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "The ID of the load balancer rule", "length": 255, - "name": "loadbalancerrulelist", + "name": "id", "related": "", "required": true, - "type": "list" + "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -159859,6 +172661,17 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -159875,27 +172688,22 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the type of the affinity group", "name": "type", @@ -159907,6 +172715,11 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -159915,14 +172728,6 @@ "isasync": false, "name": "listCapacity", "params": [ - { - "description": "Tag for the resource type", - "length": 255, - "name": "tag", - "required": false, - "since": "4.20.0", - "type": "string" - }, { "description": "", "length": 255, @@ -159931,11 +172736,10 @@ "type": "integer" }, { - "description": "Sort the results. Available values: Usage", + "description": "List by keyword", "length": 255, - "name": "sortby", + "name": "keyword", "required": false, - "since": "3.0.0", "type": "string" }, { @@ -159948,10 +172752,26 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", "length": 255, - "name": "keyword", + "name": "type", "required": false, + "type": "integer" + }, + { + "description": "recalculate capacities and fetch the latest", + "length": 255, + "name": "fetchlatest", + "required": false, + "since": "3.0.0", + "type": "boolean" + }, + { + "description": "Sort the results. Available values: Usage", + "length": 255, + "name": "sortby", + "required": false, + "since": "3.0.0", "type": "string" }, { @@ -159971,24 +172791,17 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "recalculate capacities and fetch the latest", + "description": "Tag for the resource type", "length": 255, - "name": "fetchlatest", + "name": "tag", "required": false, - "since": "3.0.0", - "type": "boolean" + "since": "4.20.0", + "type": "string" }, { - "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", + "description": "", "length": 255, - "name": "type", + "name": "page", "required": false, "type": "integer" } @@ -159996,18 +172809,28 @@ "related": "", "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -160016,14 +172839,14 @@ "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, {}, { - "description": "the Pod ID", - "name": "podid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { @@ -160032,45 +172855,35 @@ "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, + {}, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the Zone name", "name": "zonename", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Pod name", + "name": "podname", + "type": "string" } ] }, @@ -160080,42 +172893,32 @@ "name": "updateServiceOffering", "params": [ { - "description": "Whether to cleanup VM and its associated resource upon expunge", + "description": "the display text of the service offering to be updated", "length": 255, - "name": "purgeresources", + "name": "displaytext", "required": false, - "since": "4.20", - "type": "boolean" - }, - { - "description": "the ID of the service offering to be updated", - "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "description": "state of the service offering", "length": 255, - "name": "storagetags", + "name": "state", "required": false, - "since": "4.16", "type": "string" }, { - "description": "sort key of the service offering, integer", + "description": "the host tag for this service offering.", "length": 255, - "name": "sortkey", + "name": "hosttags", "required": false, - "type": "integer" + "since": "4.16", + "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "the name of the service offering to be updated", "length": 255, - "name": "hosttags", + "name": "name", "required": false, - "since": "4.16", "type": "string" }, { @@ -160126,25 +172929,35 @@ "type": "string" }, { - "description": "the name of the service offering to be updated", + "description": "sort key of the service offering, integer", "length": 255, - "name": "name", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the display text of the service offering to be updated", + "description": "Whether to cleanup VM and its associated resource upon expunge", "length": 255, - "name": "displaytext", + "name": "purgeresources", "required": false, - "type": "string" + "since": "4.20", + "type": "boolean" }, { - "description": "state of the service offering", + "description": "the ID of the service offering to be updated", "length": 255, - "name": "state", + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" + }, + { + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "length": 255, + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", @@ -160153,131 +172966,185 @@ "required": false, "since": "4.13", "type": "string" + }, + { + "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "length": 255, + "name": "storagetags", + "required": false, + "since": "4.16", + "type": "string" } ], "related": "", "response": [ { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" - }, - { - "description": "the id of the service offering", - "name": "id", - "type": "string" - }, - { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, + {}, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, { "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "name": "cacheMode", "type": "string" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, + { + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" + }, + { + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, - {}, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", + "description": "is this a system vm offering", + "name": "issystem", "type": "boolean" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, + {}, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" + }, { "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", "name": "isvolatile", @@ -160289,115 +173156,144 @@ "type": "boolean" }, { - "description": "is this a system vm offering", - "name": "issystem", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, + { + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, { "description": "the ID of the disk offering to which service offering is linked", "name": "diskofferingid", "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "is true if the offering is customized", + "name": "iscustomized", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "state of the service offering", + "name": "state", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, - {}, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { "description": "the name of the service offering", @@ -160405,34 +173301,19 @@ "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", "type": "boolean" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" - }, - { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" } ] }, @@ -160445,7 +173326,7 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances", "required": true, "type": "uuid" }, @@ -160457,27 +173338,73 @@ "type": "boolean" } ], - "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances", "response": [ { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, + {}, { "description": "ID of AutoScale VM group", "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { "description": "the user's name who deployed the virtual machine", @@ -160485,272 +173412,473 @@ "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, { "description": "Os type ID of the virtual machine", "name": "guestosid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, + {}, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" } ], "type": "set" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - {}, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -160759,177 +173887,246 @@ "type": "boolean" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "account owning the security group rule", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -160938,18 +174135,18 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -160958,18 +174155,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -160985,47 +174182,15 @@ "name": "protocol", "type": "string" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the id of the security group rule", @@ -161033,526 +174198,302 @@ "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" } ], "type": "set" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ], - "type": "set" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" } ], "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, - {}, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, + {}, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" } ] @@ -161562,13 +174503,6 @@ "isasync": true, "name": "createNetworkACLList", "params": [ - { - "description": "Description of the network ACL list", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "an optional field, whether to the display the list to the end user or not", "length": 255, @@ -161577,13 +174511,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "Name of the network ACL list", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "ID of the VPC associated with this network ACL list", "length": 255, @@ -161591,33 +174518,43 @@ "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" + }, + { + "description": "Description of the network ACL list", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "Name of the network ACL list", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the ID of the ACL", - "name": "id", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Description of the ACL", + "name": "description", + "type": "string" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { @@ -161625,20 +174562,24 @@ "name": "vpcname", "type": "string" }, - {}, + { + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, {}, { - "description": "the Name of the ACL", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Description of the ACL", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] } ], - "count": 856 + "count": 899 } diff --git a/test/ManagementService_test.go b/test/ManagementService_test.go index 0d0f6482..bcfdca1e 100644 --- a/test/ManagementService_test.go +++ b/test/ManagementService_test.go @@ -87,7 +87,7 @@ func TestManagementService(t *testing.T) { if _, ok := response["readyForShutdown"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Management.NewReadyForShutdownParams() + p := client.Management.NewReadyForShutdownParams("managementserverid") _, err := client.Management.ReadyForShutdown(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/ObjectStoreService_test.go b/test/ObjectStoreService_test.go index 7af6631f..c6107eb8 100644 --- a/test/ObjectStoreService_test.go +++ b/test/ObjectStoreService_test.go @@ -39,7 +39,7 @@ func TestObjectStoreService(t *testing.T) { if _, ok := response["createBucket"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.ObjectStore.NewCreateBucketParams("name", "objectstorageid") + p := client.ObjectStore.NewCreateBucketParams("name", "objectstorageid", 0) r, err := client.ObjectStore.CreateBucket(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/VPCService_test.go b/test/VPCService_test.go index 06a03aa2..868afce3 100644 --- a/test/VPCService_test.go +++ b/test/VPCService_test.go @@ -54,7 +54,7 @@ func TestVPCService(t *testing.T) { if _, ok := response["createStaticRoute"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.VPC.NewCreateStaticRouteParams("cidr", "gatewayid") + p := client.VPC.NewCreateStaticRouteParams("cidr") r, err := client.VPC.CreateStaticRoute(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/VirtualMachineService_test.go b/test/VirtualMachineService_test.go index 9793e9c5..7e5760ed 100644 --- a/test/VirtualMachineService_test.go +++ b/test/VirtualMachineService_test.go @@ -96,7 +96,7 @@ func TestVirtualMachineService(t *testing.T) { if _, ok := response["deployVirtualMachine"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.VirtualMachine.NewDeployVirtualMachineParams("serviceofferingid", "templateid", "zoneid") + p := client.VirtualMachine.NewDeployVirtualMachineParams("serviceofferingid", "zoneid") r, err := client.VirtualMachine.DeployVirtualMachine(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/VirtualNetworkFunctionsService_test.go b/test/VirtualNetworkFunctionsService_test.go index ba013a49..e515bf83 100644 --- a/test/VirtualNetworkFunctionsService_test.go +++ b/test/VirtualNetworkFunctionsService_test.go @@ -51,7 +51,7 @@ func TestVirtualNetworkFunctionsService(t *testing.T) { if _, ok := response["deployVnfAppliance"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.VirtualNetworkFunctions.NewDeployVnfApplianceParams("serviceofferingid", "templateid", "zoneid") + p := client.VirtualNetworkFunctions.NewDeployVnfApplianceParams("serviceofferingid", "zoneid") r, err := client.VirtualNetworkFunctions.DeployVnfAppliance(p) if err != nil { t.Errorf(err.Error()) From d30bf516d88118750643d63214ce9f45f0700668 Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Mon, 22 Sep 2025 16:56:14 -0400 Subject: [PATCH 2/6] add template_id to required params for backward compatability --- cloudstack/VirtualMachineService.go | 5 +++-- cloudstack/VirtualMachineService_mock.go | 8 ++++---- generate/requiredParams.go | 3 +++ test/VirtualMachineService_test.go | 2 +- 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 27c5eb91..3cd67fb2 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -37,7 +37,7 @@ type VirtualMachineServiceIface interface { CleanVMReservations(p *CleanVMReservationsParams) (*CleanVMReservationsResponse, error) NewCleanVMReservationsParams() *CleanVMReservationsParams DeployVirtualMachine(p *DeployVirtualMachineParams) (*DeployVirtualMachineResponse, error) - NewDeployVirtualMachineParams(serviceofferingid string, zoneid string) *DeployVirtualMachineParams + NewDeployVirtualMachineParams(serviceofferingid string, templateid string, zoneid string) *DeployVirtualMachineParams DestroyVirtualMachine(p *DestroyVirtualMachineParams) (*DestroyVirtualMachineResponse, error) NewDestroyVirtualMachineParams(id string) *DestroyVirtualMachineParams ExpungeVirtualMachine(p *ExpungeVirtualMachineParams) (*ExpungeVirtualMachineResponse, error) @@ -2784,10 +2784,11 @@ func (p *DeployVirtualMachineParams) GetZoneid() (string, bool) { // You should always use this function to get a new DeployVirtualMachineParams instance, // as then you are sure you have configured all required params -func (s *VirtualMachineService) NewDeployVirtualMachineParams(serviceofferingid string, zoneid string) *DeployVirtualMachineParams { +func (s *VirtualMachineService) NewDeployVirtualMachineParams(serviceofferingid string, templateid string, zoneid string) *DeployVirtualMachineParams { p := &DeployVirtualMachineParams{} p.p = make(map[string]interface{}) p.p["serviceofferingid"] = serviceofferingid + p.p["templateid"] = templateid p.p["zoneid"] = zoneid return p } diff --git a/cloudstack/VirtualMachineService_mock.go b/cloudstack/VirtualMachineService_mock.go index bc2f2b38..75c6e86c 100644 --- a/cloudstack/VirtualMachineService_mock.go +++ b/cloudstack/VirtualMachineService_mock.go @@ -653,17 +653,17 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewDeleteVMScheduleParams( } // NewDeployVirtualMachineParams mocks base method. -func (m *MockVirtualMachineServiceIface) NewDeployVirtualMachineParams(serviceofferingid, zoneid string) *DeployVirtualMachineParams { +func (m *MockVirtualMachineServiceIface) NewDeployVirtualMachineParams(serviceofferingid, templateid, zoneid string) *DeployVirtualMachineParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewDeployVirtualMachineParams", serviceofferingid, zoneid) + ret := m.ctrl.Call(m, "NewDeployVirtualMachineParams", serviceofferingid, templateid, zoneid) ret0, _ := ret[0].(*DeployVirtualMachineParams) return ret0 } // NewDeployVirtualMachineParams indicates an expected call of NewDeployVirtualMachineParams. -func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewDeployVirtualMachineParams(serviceofferingid, zoneid any) *gomock.Call { +func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewDeployVirtualMachineParams(serviceofferingid, templateid, zoneid any) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeployVirtualMachineParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewDeployVirtualMachineParams), serviceofferingid, zoneid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeployVirtualMachineParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewDeployVirtualMachineParams), serviceofferingid, templateid, zoneid) } // NewDestroyVirtualMachineParams mocks base method. diff --git a/generate/requiredParams.go b/generate/requiredParams.go index 602bc4ef..2df50617 100644 --- a/generate/requiredParams.go +++ b/generate/requiredParams.go @@ -55,6 +55,9 @@ var requiredParams = map[string][]string{ "createVPCOffering": { "displaytext", }, + "deployVirtualMachine": { + "templateid", + }, "disassociateIpAddress": { "id", }, diff --git a/test/VirtualMachineService_test.go b/test/VirtualMachineService_test.go index 7e5760ed..9793e9c5 100644 --- a/test/VirtualMachineService_test.go +++ b/test/VirtualMachineService_test.go @@ -96,7 +96,7 @@ func TestVirtualMachineService(t *testing.T) { if _, ok := response["deployVirtualMachine"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.VirtualMachine.NewDeployVirtualMachineParams("serviceofferingid", "zoneid") + p := client.VirtualMachine.NewDeployVirtualMachineParams("serviceofferingid", "templateid", "zoneid") r, err := client.VirtualMachine.DeployVirtualMachine(p) if err != nil { t.Errorf(err.Error()) From 662aa6da98efcb033694e7562412827dae66af2a Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Tue, 23 Sep 2025 02:12:21 -0400 Subject: [PATCH 3/6] Add support for GPU apis (#121) --- cloudstack/GPUService.go | 2923 +++++++++++++++++++++++++++++++++ cloudstack/GPUService_mock.go | 641 ++++++++ cloudstack/cloudstack.go | 11 + generate/layout.go | 17 + test/GPUService_test.go | 239 +++ 5 files changed, 3831 insertions(+) create mode 100644 cloudstack/GPUService.go create mode 100644 cloudstack/GPUService_mock.go create mode 100644 test/GPUService_test.go diff --git a/cloudstack/GPUService.go b/cloudstack/GPUService.go new file mode 100644 index 00000000..753f5cc6 --- /dev/null +++ b/cloudstack/GPUService.go @@ -0,0 +1,2923 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package cloudstack + +import ( + "encoding/json" + "fmt" + "net/url" + "strconv" + "strings" +) + +type GPUServiceIface interface { + CreateGpuCard(p *CreateGpuCardParams) (*CreateGpuCardResponse, error) + NewCreateGpuCardParams(deviceid string, devicename string, name string, vendorid string, vendorname string) *CreateGpuCardParams + CreateGpuDevice(p *CreateGpuDeviceParams) (*CreateGpuDeviceResponse, error) + NewCreateGpuDeviceParams(busaddress string, gpucardid string, hostid string, vgpuprofileid string) *CreateGpuDeviceParams + CreateVgpuProfile(p *CreateVgpuProfileParams) (*CreateVgpuProfileResponse, error) + NewCreateVgpuProfileParams(gpucardid string, name string) *CreateVgpuProfileParams + DeleteGpuCard(p *DeleteGpuCardParams) (*DeleteGpuCardResponse, error) + NewDeleteGpuCardParams(id string) *DeleteGpuCardParams + DeleteGpuDevice(p *DeleteGpuDeviceParams) (*DeleteGpuDeviceResponse, error) + NewDeleteGpuDeviceParams(ids []string) *DeleteGpuDeviceParams + DeleteVgpuProfile(p *DeleteVgpuProfileParams) (*DeleteVgpuProfileResponse, error) + NewDeleteVgpuProfileParams(id string) *DeleteVgpuProfileParams + DiscoverGpuDevices(p *DiscoverGpuDevicesParams) (*DiscoverGpuDevicesResponse, error) + NewDiscoverGpuDevicesParams(id string) *DiscoverGpuDevicesParams + ListGpuCards(p *ListGpuCardsParams) (*ListGpuCardsResponse, error) + NewListGpuCardsParams() *ListGpuCardsParams + GetGpuCardID(keyword string, opts ...OptionFunc) (string, int, error) + GetGpuCardByName(name string, opts ...OptionFunc) (*GpuCard, int, error) + GetGpuCardByID(id string, opts ...OptionFunc) (*GpuCard, int, error) + ListGpuDevices(p *ListGpuDevicesParams) (*ListGpuDevicesResponse, error) + NewListGpuDevicesParams() *ListGpuDevicesParams + GetGpuDeviceByID(id string, opts ...OptionFunc) (*GpuDevice, int, error) + ListVgpuProfiles(p *ListVgpuProfilesParams) (*ListVgpuProfilesResponse, error) + NewListVgpuProfilesParams() *ListVgpuProfilesParams + GetVgpuProfileID(name string, opts ...OptionFunc) (string, int, error) + GetVgpuProfileByName(name string, opts ...OptionFunc) (*VgpuProfile, int, error) + GetVgpuProfileByID(id string, opts ...OptionFunc) (*VgpuProfile, int, error) + ManageGpuDevice(p *ManageGpuDeviceParams) (*ManageGpuDeviceResponse, error) + NewManageGpuDeviceParams(ids []string) *ManageGpuDeviceParams + UnmanageGpuDevice(p *UnmanageGpuDeviceParams) (*UnmanageGpuDeviceResponse, error) + NewUnmanageGpuDeviceParams(ids []string) *UnmanageGpuDeviceParams + UpdateGpuCard(p *UpdateGpuCardParams) (*UpdateGpuCardResponse, error) + NewUpdateGpuCardParams(id string) *UpdateGpuCardParams + UpdateGpuDevice(p *UpdateGpuDeviceParams) (*UpdateGpuDeviceResponse, error) + NewUpdateGpuDeviceParams(id string) *UpdateGpuDeviceParams + UpdateVgpuProfile(p *UpdateVgpuProfileParams) (*UpdateVgpuProfileResponse, error) + NewUpdateVgpuProfileParams(id string) *UpdateVgpuProfileParams +} + +type CreateGpuCardParams struct { + p map[string]interface{} +} + +func (p *CreateGpuCardParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["deviceid"]; found { + u.Set("deviceid", v.(string)) + } + if v, found := p.p["devicename"]; found { + u.Set("devicename", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["vendorid"]; found { + u.Set("vendorid", v.(string)) + } + if v, found := p.p["vendorname"]; found { + u.Set("vendorname", v.(string)) + } + if v, found := p.p["videoram"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("videoram", vv) + } + return u +} + +func (p *CreateGpuCardParams) SetDeviceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["deviceid"] = v +} + +func (p *CreateGpuCardParams) ResetDeviceid() { + if p.p != nil && p.p["deviceid"] != nil { + delete(p.p, "deviceid") + } +} + +func (p *CreateGpuCardParams) GetDeviceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["deviceid"].(string) + return value, ok +} + +func (p *CreateGpuCardParams) SetDevicename(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["devicename"] = v +} + +func (p *CreateGpuCardParams) ResetDevicename() { + if p.p != nil && p.p["devicename"] != nil { + delete(p.p, "devicename") + } +} + +func (p *CreateGpuCardParams) GetDevicename() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["devicename"].(string) + return value, ok +} + +func (p *CreateGpuCardParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *CreateGpuCardParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *CreateGpuCardParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *CreateGpuCardParams) SetVendorid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vendorid"] = v +} + +func (p *CreateGpuCardParams) ResetVendorid() { + if p.p != nil && p.p["vendorid"] != nil { + delete(p.p, "vendorid") + } +} + +func (p *CreateGpuCardParams) GetVendorid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vendorid"].(string) + return value, ok +} + +func (p *CreateGpuCardParams) SetVendorname(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vendorname"] = v +} + +func (p *CreateGpuCardParams) ResetVendorname() { + if p.p != nil && p.p["vendorname"] != nil { + delete(p.p, "vendorname") + } +} + +func (p *CreateGpuCardParams) GetVendorname() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vendorname"].(string) + return value, ok +} + +func (p *CreateGpuCardParams) SetVideoram(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["videoram"] = v +} + +func (p *CreateGpuCardParams) ResetVideoram() { + if p.p != nil && p.p["videoram"] != nil { + delete(p.p, "videoram") + } +} + +func (p *CreateGpuCardParams) GetVideoram() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["videoram"].(int64) + return value, ok +} + +// You should always use this function to get a new CreateGpuCardParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewCreateGpuCardParams(deviceid string, devicename string, name string, vendorid string, vendorname string) *CreateGpuCardParams { + p := &CreateGpuCardParams{} + p.p = make(map[string]interface{}) + p.p["deviceid"] = deviceid + p.p["devicename"] = devicename + p.p["name"] = name + p.p["vendorid"] = vendorid + p.p["vendorname"] = vendorname + return p +} + +// Creates a GPU card definition in the system +func (s *GPUService) CreateGpuCard(p *CreateGpuCardParams) (*CreateGpuCardResponse, error) { + resp, err := s.cs.newPostRequest("createGpuCard", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateGpuCardResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type CreateGpuCardResponse struct { + Deviceid string `json:"deviceid"` + Devicename string `json:"devicename"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Vendorid string `json:"vendorid"` + Vendorname string `json:"vendorname"` +} + +type CreateGpuDeviceParams struct { + p map[string]interface{} +} + +func (p *CreateGpuDeviceParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["busaddress"]; found { + u.Set("busaddress", v.(string)) + } + if v, found := p.p["gpucardid"]; found { + u.Set("gpucardid", v.(string)) + } + if v, found := p.p["hostid"]; found { + u.Set("hostid", v.(string)) + } + if v, found := p.p["numanode"]; found { + u.Set("numanode", v.(string)) + } + if v, found := p.p["parentgpudeviceid"]; found { + u.Set("parentgpudeviceid", v.(string)) + } + if v, found := p.p["type"]; found { + u.Set("type", v.(string)) + } + if v, found := p.p["vgpuprofileid"]; found { + u.Set("vgpuprofileid", v.(string)) + } + return u +} + +func (p *CreateGpuDeviceParams) SetBusaddress(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["busaddress"] = v +} + +func (p *CreateGpuDeviceParams) ResetBusaddress() { + if p.p != nil && p.p["busaddress"] != nil { + delete(p.p, "busaddress") + } +} + +func (p *CreateGpuDeviceParams) GetBusaddress() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["busaddress"].(string) + return value, ok +} + +func (p *CreateGpuDeviceParams) SetGpucardid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpucardid"] = v +} + +func (p *CreateGpuDeviceParams) ResetGpucardid() { + if p.p != nil && p.p["gpucardid"] != nil { + delete(p.p, "gpucardid") + } +} + +func (p *CreateGpuDeviceParams) GetGpucardid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpucardid"].(string) + return value, ok +} + +func (p *CreateGpuDeviceParams) SetHostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hostid"] = v +} + +func (p *CreateGpuDeviceParams) ResetHostid() { + if p.p != nil && p.p["hostid"] != nil { + delete(p.p, "hostid") + } +} + +func (p *CreateGpuDeviceParams) GetHostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hostid"].(string) + return value, ok +} + +func (p *CreateGpuDeviceParams) SetNumanode(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["numanode"] = v +} + +func (p *CreateGpuDeviceParams) ResetNumanode() { + if p.p != nil && p.p["numanode"] != nil { + delete(p.p, "numanode") + } +} + +func (p *CreateGpuDeviceParams) GetNumanode() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["numanode"].(string) + return value, ok +} + +func (p *CreateGpuDeviceParams) SetParentgpudeviceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["parentgpudeviceid"] = v +} + +func (p *CreateGpuDeviceParams) ResetParentgpudeviceid() { + if p.p != nil && p.p["parentgpudeviceid"] != nil { + delete(p.p, "parentgpudeviceid") + } +} + +func (p *CreateGpuDeviceParams) GetParentgpudeviceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["parentgpudeviceid"].(string) + return value, ok +} + +func (p *CreateGpuDeviceParams) SetType(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["type"] = v +} + +func (p *CreateGpuDeviceParams) ResetType() { + if p.p != nil && p.p["type"] != nil { + delete(p.p, "type") + } +} + +func (p *CreateGpuDeviceParams) GetType() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["type"].(string) + return value, ok +} + +func (p *CreateGpuDeviceParams) SetVgpuprofileid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vgpuprofileid"] = v +} + +func (p *CreateGpuDeviceParams) ResetVgpuprofileid() { + if p.p != nil && p.p["vgpuprofileid"] != nil { + delete(p.p, "vgpuprofileid") + } +} + +func (p *CreateGpuDeviceParams) GetVgpuprofileid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vgpuprofileid"].(string) + return value, ok +} + +// You should always use this function to get a new CreateGpuDeviceParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewCreateGpuDeviceParams(busaddress string, gpucardid string, hostid string, vgpuprofileid string) *CreateGpuDeviceParams { + p := &CreateGpuDeviceParams{} + p.p = make(map[string]interface{}) + p.p["busaddress"] = busaddress + p.p["gpucardid"] = gpucardid + p.p["hostid"] = hostid + p.p["vgpuprofileid"] = vgpuprofileid + return p +} + +// Creates a GPU device manually on a host +func (s *GPUService) CreateGpuDevice(p *CreateGpuDeviceParams) (*CreateGpuDeviceResponse, error) { + resp, err := s.cs.newPostRequest("createGpuDevice", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateGpuDeviceResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type CreateGpuDeviceResponse struct { + Busaddress string `json:"busaddress"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpudevicetype string `json:"gpudevicetype"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Managedstate string `json:"managedstate"` + Numanode string `json:"numanode"` + Parentgpudeviceid string `json:"parentgpudeviceid"` + State string `json:"state"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Vmstate string `json:"vmstate"` +} + +type CreateVgpuProfileParams struct { + p map[string]interface{} +} + +func (p *CreateVgpuProfileParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["gpucardid"]; found { + u.Set("gpucardid", v.(string)) + } + if v, found := p.p["maxheads"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxheads", vv) + } + if v, found := p.p["maxresolutionx"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxresolutionx", vv) + } + if v, found := p.p["maxresolutiony"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxresolutiony", vv) + } + if v, found := p.p["maxvgpuperphysicalgpu"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxvgpuperphysicalgpu", vv) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["videoram"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("videoram", vv) + } + return u +} + +func (p *CreateVgpuProfileParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *CreateVgpuProfileParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *CreateVgpuProfileParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *CreateVgpuProfileParams) SetGpucardid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpucardid"] = v +} + +func (p *CreateVgpuProfileParams) ResetGpucardid() { + if p.p != nil && p.p["gpucardid"] != nil { + delete(p.p, "gpucardid") + } +} + +func (p *CreateVgpuProfileParams) GetGpucardid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpucardid"].(string) + return value, ok +} + +func (p *CreateVgpuProfileParams) SetMaxheads(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxheads"] = v +} + +func (p *CreateVgpuProfileParams) ResetMaxheads() { + if p.p != nil && p.p["maxheads"] != nil { + delete(p.p, "maxheads") + } +} + +func (p *CreateVgpuProfileParams) GetMaxheads() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxheads"].(int64) + return value, ok +} + +func (p *CreateVgpuProfileParams) SetMaxresolutionx(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxresolutionx"] = v +} + +func (p *CreateVgpuProfileParams) ResetMaxresolutionx() { + if p.p != nil && p.p["maxresolutionx"] != nil { + delete(p.p, "maxresolutionx") + } +} + +func (p *CreateVgpuProfileParams) GetMaxresolutionx() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxresolutionx"].(int64) + return value, ok +} + +func (p *CreateVgpuProfileParams) SetMaxresolutiony(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxresolutiony"] = v +} + +func (p *CreateVgpuProfileParams) ResetMaxresolutiony() { + if p.p != nil && p.p["maxresolutiony"] != nil { + delete(p.p, "maxresolutiony") + } +} + +func (p *CreateVgpuProfileParams) GetMaxresolutiony() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxresolutiony"].(int64) + return value, ok +} + +func (p *CreateVgpuProfileParams) SetMaxvgpuperphysicalgpu(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxvgpuperphysicalgpu"] = v +} + +func (p *CreateVgpuProfileParams) ResetMaxvgpuperphysicalgpu() { + if p.p != nil && p.p["maxvgpuperphysicalgpu"] != nil { + delete(p.p, "maxvgpuperphysicalgpu") + } +} + +func (p *CreateVgpuProfileParams) GetMaxvgpuperphysicalgpu() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxvgpuperphysicalgpu"].(int64) + return value, ok +} + +func (p *CreateVgpuProfileParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *CreateVgpuProfileParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *CreateVgpuProfileParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *CreateVgpuProfileParams) SetVideoram(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["videoram"] = v +} + +func (p *CreateVgpuProfileParams) ResetVideoram() { + if p.p != nil && p.p["videoram"] != nil { + delete(p.p, "videoram") + } +} + +func (p *CreateVgpuProfileParams) GetVideoram() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["videoram"].(int64) + return value, ok +} + +// You should always use this function to get a new CreateVgpuProfileParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewCreateVgpuProfileParams(gpucardid string, name string) *CreateVgpuProfileParams { + p := &CreateVgpuProfileParams{} + p.p = make(map[string]interface{}) + p.p["gpucardid"] = gpucardid + p.p["name"] = name + return p +} + +// Creates a vGPU profile in the system +func (s *GPUService) CreateVgpuProfile(p *CreateVgpuProfileParams) (*CreateVgpuProfileResponse, error) { + resp, err := s.cs.newPostRequest("createVgpuProfile", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateVgpuProfileResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type CreateVgpuProfileResponse struct { + Description string `json:"description"` + Deviceid string `json:"deviceid"` + Devicename string `json:"devicename"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` + Maxvgpuperphysicalgpu int64 `json:"maxvgpuperphysicalgpu"` + Name string `json:"name"` + Vendorid string `json:"vendorid"` + Vendorname string `json:"vendorname"` + Videoram int64 `json:"videoram"` +} + +type DeleteGpuCardParams struct { + p map[string]interface{} +} + +func (p *DeleteGpuCardParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteGpuCardParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteGpuCardParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteGpuCardParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteGpuCardParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewDeleteGpuCardParams(id string) *DeleteGpuCardParams { + p := &DeleteGpuCardParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Deletes a GPU card definition from the system +func (s *GPUService) DeleteGpuCard(p *DeleteGpuCardParams) (*DeleteGpuCardResponse, error) { + resp, err := s.cs.newPostRequest("deleteGpuCard", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteGpuCardResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteGpuCardResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *DeleteGpuCardResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias DeleteGpuCardResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type DeleteGpuDeviceParams struct { + p map[string]interface{} +} + +func (p *DeleteGpuDeviceParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["ids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("ids", vv) + } + return u +} + +func (p *DeleteGpuDeviceParams) SetIds(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ids"] = v +} + +func (p *DeleteGpuDeviceParams) ResetIds() { + if p.p != nil && p.p["ids"] != nil { + delete(p.p, "ids") + } +} + +func (p *DeleteGpuDeviceParams) GetIds() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ids"].([]string) + return value, ok +} + +// You should always use this function to get a new DeleteGpuDeviceParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewDeleteGpuDeviceParams(ids []string) *DeleteGpuDeviceParams { + p := &DeleteGpuDeviceParams{} + p.p = make(map[string]interface{}) + p.p["ids"] = ids + return p +} + +// Deletes a vGPU profile from the system +func (s *GPUService) DeleteGpuDevice(p *DeleteGpuDeviceParams) (*DeleteGpuDeviceResponse, error) { + resp, err := s.cs.newPostRequest("deleteGpuDevice", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteGpuDeviceResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteGpuDeviceResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *DeleteGpuDeviceResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias DeleteGpuDeviceResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type DeleteVgpuProfileParams struct { + p map[string]interface{} +} + +func (p *DeleteVgpuProfileParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteVgpuProfileParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteVgpuProfileParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteVgpuProfileParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteVgpuProfileParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewDeleteVgpuProfileParams(id string) *DeleteVgpuProfileParams { + p := &DeleteVgpuProfileParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Deletes a vGPU profile from the system +func (s *GPUService) DeleteVgpuProfile(p *DeleteVgpuProfileParams) (*DeleteVgpuProfileResponse, error) { + resp, err := s.cs.newPostRequest("deleteVgpuProfile", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteVgpuProfileResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteVgpuProfileResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *DeleteVgpuProfileResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias DeleteVgpuProfileResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type DiscoverGpuDevicesParams struct { + p map[string]interface{} +} + +func (p *DiscoverGpuDevicesParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + return u +} + +func (p *DiscoverGpuDevicesParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DiscoverGpuDevicesParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DiscoverGpuDevicesParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *DiscoverGpuDevicesParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *DiscoverGpuDevicesParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *DiscoverGpuDevicesParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *DiscoverGpuDevicesParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *DiscoverGpuDevicesParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *DiscoverGpuDevicesParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *DiscoverGpuDevicesParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *DiscoverGpuDevicesParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *DiscoverGpuDevicesParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +// You should always use this function to get a new DiscoverGpuDevicesParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewDiscoverGpuDevicesParams(id string) *DiscoverGpuDevicesParams { + p := &DiscoverGpuDevicesParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Discovers available GPU devices on a host +func (s *GPUService) DiscoverGpuDevices(p *DiscoverGpuDevicesParams) (*DiscoverGpuDevicesResponse, error) { + resp, err := s.cs.newPostRequest("discoverGpuDevices", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DiscoverGpuDevicesResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DiscoverGpuDevicesResponse struct { + Busaddress string `json:"busaddress"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpudevicetype string `json:"gpudevicetype"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Managedstate string `json:"managedstate"` + Numanode string `json:"numanode"` + Parentgpudeviceid string `json:"parentgpudeviceid"` + State string `json:"state"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Vmstate string `json:"vmstate"` +} + +type ListGpuCardsParams struct { + p map[string]interface{} +} + +func (p *ListGpuCardsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["activeonly"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("activeonly", vv) + } + if v, found := p.p["deviceid"]; found { + u.Set("deviceid", v.(string)) + } + if v, found := p.p["devicename"]; found { + u.Set("devicename", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["vendorid"]; found { + u.Set("vendorid", v.(string)) + } + if v, found := p.p["vendorname"]; found { + u.Set("vendorname", v.(string)) + } + return u +} + +func (p *ListGpuCardsParams) SetActiveonly(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["activeonly"] = v +} + +func (p *ListGpuCardsParams) ResetActiveonly() { + if p.p != nil && p.p["activeonly"] != nil { + delete(p.p, "activeonly") + } +} + +func (p *ListGpuCardsParams) GetActiveonly() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["activeonly"].(bool) + return value, ok +} + +func (p *ListGpuCardsParams) SetDeviceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["deviceid"] = v +} + +func (p *ListGpuCardsParams) ResetDeviceid() { + if p.p != nil && p.p["deviceid"] != nil { + delete(p.p, "deviceid") + } +} + +func (p *ListGpuCardsParams) GetDeviceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["deviceid"].(string) + return value, ok +} + +func (p *ListGpuCardsParams) SetDevicename(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["devicename"] = v +} + +func (p *ListGpuCardsParams) ResetDevicename() { + if p.p != nil && p.p["devicename"] != nil { + delete(p.p, "devicename") + } +} + +func (p *ListGpuCardsParams) GetDevicename() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["devicename"].(string) + return value, ok +} + +func (p *ListGpuCardsParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListGpuCardsParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListGpuCardsParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListGpuCardsParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListGpuCardsParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListGpuCardsParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListGpuCardsParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListGpuCardsParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListGpuCardsParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListGpuCardsParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListGpuCardsParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListGpuCardsParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListGpuCardsParams) SetVendorid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vendorid"] = v +} + +func (p *ListGpuCardsParams) ResetVendorid() { + if p.p != nil && p.p["vendorid"] != nil { + delete(p.p, "vendorid") + } +} + +func (p *ListGpuCardsParams) GetVendorid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vendorid"].(string) + return value, ok +} + +func (p *ListGpuCardsParams) SetVendorname(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vendorname"] = v +} + +func (p *ListGpuCardsParams) ResetVendorname() { + if p.p != nil && p.p["vendorname"] != nil { + delete(p.p, "vendorname") + } +} + +func (p *ListGpuCardsParams) GetVendorname() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vendorname"].(string) + return value, ok +} + +// You should always use this function to get a new ListGpuCardsParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewListGpuCardsParams() *ListGpuCardsParams { + p := &ListGpuCardsParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *GPUService) GetGpuCardID(keyword string, opts ...OptionFunc) (string, int, error) { + p := &ListGpuCardsParams{} + p.p = make(map[string]interface{}) + + p.p["keyword"] = keyword + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListGpuCards(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", keyword, l) + } + + if l.Count == 1 { + return l.GpuCards[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.GpuCards { + if v.Name == keyword { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *GPUService) GetGpuCardByName(name string, opts ...OptionFunc) (*GpuCard, int, error) { + id, count, err := s.GetGpuCardID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetGpuCardByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *GPUService) GetGpuCardByID(id string, opts ...OptionFunc) (*GpuCard, int, error) { + p := &ListGpuCardsParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListGpuCards(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.GpuCards[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for GpuCard UUID: %s!", id) +} + +// Lists all available GPU cards +func (s *GPUService) ListGpuCards(p *ListGpuCardsParams) (*ListGpuCardsResponse, error) { + resp, err := s.cs.newRequest("listGpuCards", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListGpuCardsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListGpuCardsResponse struct { + Count int `json:"count"` + GpuCards []*GpuCard `json:"gpucard"` +} + +type GpuCard struct { + Deviceid string `json:"deviceid"` + Devicename string `json:"devicename"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Vendorid string `json:"vendorid"` + Vendorname string `json:"vendorname"` +} + +type ListGpuDevicesParams struct { + p map[string]interface{} +} + +func (p *ListGpuDevicesParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["gpucardid"]; found { + u.Set("gpucardid", v.(string)) + } + if v, found := p.p["hostid"]; found { + u.Set("hostid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["vgpuprofileid"]; found { + u.Set("vgpuprofileid", v.(string)) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + return u +} + +func (p *ListGpuDevicesParams) SetGpucardid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpucardid"] = v +} + +func (p *ListGpuDevicesParams) ResetGpucardid() { + if p.p != nil && p.p["gpucardid"] != nil { + delete(p.p, "gpucardid") + } +} + +func (p *ListGpuDevicesParams) GetGpucardid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpucardid"].(string) + return value, ok +} + +func (p *ListGpuDevicesParams) SetHostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hostid"] = v +} + +func (p *ListGpuDevicesParams) ResetHostid() { + if p.p != nil && p.p["hostid"] != nil { + delete(p.p, "hostid") + } +} + +func (p *ListGpuDevicesParams) GetHostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hostid"].(string) + return value, ok +} + +func (p *ListGpuDevicesParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListGpuDevicesParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListGpuDevicesParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListGpuDevicesParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListGpuDevicesParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListGpuDevicesParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListGpuDevicesParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListGpuDevicesParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListGpuDevicesParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListGpuDevicesParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListGpuDevicesParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListGpuDevicesParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListGpuDevicesParams) SetVgpuprofileid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vgpuprofileid"] = v +} + +func (p *ListGpuDevicesParams) ResetVgpuprofileid() { + if p.p != nil && p.p["vgpuprofileid"] != nil { + delete(p.p, "vgpuprofileid") + } +} + +func (p *ListGpuDevicesParams) GetVgpuprofileid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vgpuprofileid"].(string) + return value, ok +} + +func (p *ListGpuDevicesParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *ListGpuDevicesParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *ListGpuDevicesParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +// You should always use this function to get a new ListGpuDevicesParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewListGpuDevicesParams() *ListGpuDevicesParams { + p := &ListGpuDevicesParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *GPUService) GetGpuDeviceByID(id string, opts ...OptionFunc) (*GpuDevice, int, error) { + p := &ListGpuDevicesParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListGpuDevices(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.GpuDevices[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for GpuDevice UUID: %s!", id) +} + +// Lists all available GPU devices +func (s *GPUService) ListGpuDevices(p *ListGpuDevicesParams) (*ListGpuDevicesResponse, error) { + resp, err := s.cs.newRequest("listGpuDevices", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListGpuDevicesResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListGpuDevicesResponse struct { + Count int `json:"count"` + GpuDevices []*GpuDevice `json:"gpudevice"` +} + +type GpuDevice struct { + Busaddress string `json:"busaddress"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpudevicetype string `json:"gpudevicetype"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Managedstate string `json:"managedstate"` + Numanode string `json:"numanode"` + Parentgpudeviceid string `json:"parentgpudeviceid"` + State string `json:"state"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Vmstate string `json:"vmstate"` +} + +type ListVgpuProfilesParams struct { + p map[string]interface{} +} + +func (p *ListVgpuProfilesParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["activeonly"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("activeonly", vv) + } + if v, found := p.p["gpucardid"]; found { + u.Set("gpucardid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + return u +} + +func (p *ListVgpuProfilesParams) SetActiveonly(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["activeonly"] = v +} + +func (p *ListVgpuProfilesParams) ResetActiveonly() { + if p.p != nil && p.p["activeonly"] != nil { + delete(p.p, "activeonly") + } +} + +func (p *ListVgpuProfilesParams) GetActiveonly() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["activeonly"].(bool) + return value, ok +} + +func (p *ListVgpuProfilesParams) SetGpucardid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpucardid"] = v +} + +func (p *ListVgpuProfilesParams) ResetGpucardid() { + if p.p != nil && p.p["gpucardid"] != nil { + delete(p.p, "gpucardid") + } +} + +func (p *ListVgpuProfilesParams) GetGpucardid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpucardid"].(string) + return value, ok +} + +func (p *ListVgpuProfilesParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListVgpuProfilesParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListVgpuProfilesParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListVgpuProfilesParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListVgpuProfilesParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListVgpuProfilesParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListVgpuProfilesParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListVgpuProfilesParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ListVgpuProfilesParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ListVgpuProfilesParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListVgpuProfilesParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListVgpuProfilesParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListVgpuProfilesParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListVgpuProfilesParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListVgpuProfilesParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +// You should always use this function to get a new ListVgpuProfilesParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewListVgpuProfilesParams() *ListVgpuProfilesParams { + p := &ListVgpuProfilesParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *GPUService) GetVgpuProfileID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListVgpuProfilesParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListVgpuProfiles(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.VgpuProfiles[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.VgpuProfiles { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *GPUService) GetVgpuProfileByName(name string, opts ...OptionFunc) (*VgpuProfile, int, error) { + id, count, err := s.GetVgpuProfileID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetVgpuProfileByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *GPUService) GetVgpuProfileByID(id string, opts ...OptionFunc) (*VgpuProfile, int, error) { + p := &ListVgpuProfilesParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListVgpuProfiles(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.VgpuProfiles[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for VgpuProfile UUID: %s!", id) +} + +// Lists all available vGPU profiles +func (s *GPUService) ListVgpuProfiles(p *ListVgpuProfilesParams) (*ListVgpuProfilesResponse, error) { + resp, err := s.cs.newRequest("listVgpuProfiles", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListVgpuProfilesResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListVgpuProfilesResponse struct { + Count int `json:"count"` + VgpuProfiles []*VgpuProfile `json:"vgpuprofile"` +} + +type VgpuProfile struct { + Description string `json:"description"` + Deviceid string `json:"deviceid"` + Devicename string `json:"devicename"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` + Maxvgpuperphysicalgpu int64 `json:"maxvgpuperphysicalgpu"` + Name string `json:"name"` + Vendorid string `json:"vendorid"` + Vendorname string `json:"vendorname"` + Videoram int64 `json:"videoram"` +} + +type ManageGpuDeviceParams struct { + p map[string]interface{} +} + +func (p *ManageGpuDeviceParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["ids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("ids", vv) + } + return u +} + +func (p *ManageGpuDeviceParams) SetIds(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ids"] = v +} + +func (p *ManageGpuDeviceParams) ResetIds() { + if p.p != nil && p.p["ids"] != nil { + delete(p.p, "ids") + } +} + +func (p *ManageGpuDeviceParams) GetIds() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ids"].([]string) + return value, ok +} + +// You should always use this function to get a new ManageGpuDeviceParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewManageGpuDeviceParams(ids []string) *ManageGpuDeviceParams { + p := &ManageGpuDeviceParams{} + p.p = make(map[string]interface{}) + p.p["ids"] = ids + return p +} + +// Manages a GPU device +func (s *GPUService) ManageGpuDevice(p *ManageGpuDeviceParams) (*ManageGpuDeviceResponse, error) { + resp, err := s.cs.newPostRequest("manageGpuDevice", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ManageGpuDeviceResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ManageGpuDeviceResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *ManageGpuDeviceResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias ManageGpuDeviceResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type UnmanageGpuDeviceParams struct { + p map[string]interface{} +} + +func (p *UnmanageGpuDeviceParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["ids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("ids", vv) + } + return u +} + +func (p *UnmanageGpuDeviceParams) SetIds(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ids"] = v +} + +func (p *UnmanageGpuDeviceParams) ResetIds() { + if p.p != nil && p.p["ids"] != nil { + delete(p.p, "ids") + } +} + +func (p *UnmanageGpuDeviceParams) GetIds() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ids"].([]string) + return value, ok +} + +// You should always use this function to get a new UnmanageGpuDeviceParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewUnmanageGpuDeviceParams(ids []string) *UnmanageGpuDeviceParams { + p := &UnmanageGpuDeviceParams{} + p.p = make(map[string]interface{}) + p.p["ids"] = ids + return p +} + +// Unmanage a GPU device +func (s *GPUService) UnmanageGpuDevice(p *UnmanageGpuDeviceParams) (*UnmanageGpuDeviceResponse, error) { + resp, err := s.cs.newPostRequest("unmanageGpuDevice", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UnmanageGpuDeviceResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UnmanageGpuDeviceResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *UnmanageGpuDeviceResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias UnmanageGpuDeviceResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type UpdateGpuCardParams struct { + p map[string]interface{} +} + +func (p *UpdateGpuCardParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["devicename"]; found { + u.Set("devicename", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["vendorname"]; found { + u.Set("vendorname", v.(string)) + } + return u +} + +func (p *UpdateGpuCardParams) SetDevicename(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["devicename"] = v +} + +func (p *UpdateGpuCardParams) ResetDevicename() { + if p.p != nil && p.p["devicename"] != nil { + delete(p.p, "devicename") + } +} + +func (p *UpdateGpuCardParams) GetDevicename() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["devicename"].(string) + return value, ok +} + +func (p *UpdateGpuCardParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *UpdateGpuCardParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *UpdateGpuCardParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *UpdateGpuCardParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *UpdateGpuCardParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *UpdateGpuCardParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *UpdateGpuCardParams) SetVendorname(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vendorname"] = v +} + +func (p *UpdateGpuCardParams) ResetVendorname() { + if p.p != nil && p.p["vendorname"] != nil { + delete(p.p, "vendorname") + } +} + +func (p *UpdateGpuCardParams) GetVendorname() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vendorname"].(string) + return value, ok +} + +// You should always use this function to get a new UpdateGpuCardParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewUpdateGpuCardParams(id string) *UpdateGpuCardParams { + p := &UpdateGpuCardParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Updates a GPU card definition in the system +func (s *GPUService) UpdateGpuCard(p *UpdateGpuCardParams) (*UpdateGpuCardResponse, error) { + resp, err := s.cs.newPostRequest("updateGpuCard", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateGpuCardResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UpdateGpuCardResponse struct { + Deviceid string `json:"deviceid"` + Devicename string `json:"devicename"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Vendorid string `json:"vendorid"` + Vendorname string `json:"vendorname"` +} + +type UpdateGpuDeviceParams struct { + p map[string]interface{} +} + +func (p *UpdateGpuDeviceParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["gpucardid"]; found { + u.Set("gpucardid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["numanode"]; found { + u.Set("numanode", v.(string)) + } + if v, found := p.p["parentgpudeviceid"]; found { + u.Set("parentgpudeviceid", v.(string)) + } + if v, found := p.p["type"]; found { + u.Set("type", v.(string)) + } + if v, found := p.p["vgpuprofileid"]; found { + u.Set("vgpuprofileid", v.(string)) + } + return u +} + +func (p *UpdateGpuDeviceParams) SetGpucardid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["gpucardid"] = v +} + +func (p *UpdateGpuDeviceParams) ResetGpucardid() { + if p.p != nil && p.p["gpucardid"] != nil { + delete(p.p, "gpucardid") + } +} + +func (p *UpdateGpuDeviceParams) GetGpucardid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["gpucardid"].(string) + return value, ok +} + +func (p *UpdateGpuDeviceParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *UpdateGpuDeviceParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *UpdateGpuDeviceParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *UpdateGpuDeviceParams) SetNumanode(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["numanode"] = v +} + +func (p *UpdateGpuDeviceParams) ResetNumanode() { + if p.p != nil && p.p["numanode"] != nil { + delete(p.p, "numanode") + } +} + +func (p *UpdateGpuDeviceParams) GetNumanode() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["numanode"].(string) + return value, ok +} + +func (p *UpdateGpuDeviceParams) SetParentgpudeviceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["parentgpudeviceid"] = v +} + +func (p *UpdateGpuDeviceParams) ResetParentgpudeviceid() { + if p.p != nil && p.p["parentgpudeviceid"] != nil { + delete(p.p, "parentgpudeviceid") + } +} + +func (p *UpdateGpuDeviceParams) GetParentgpudeviceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["parentgpudeviceid"].(string) + return value, ok +} + +func (p *UpdateGpuDeviceParams) SetType(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["type"] = v +} + +func (p *UpdateGpuDeviceParams) ResetType() { + if p.p != nil && p.p["type"] != nil { + delete(p.p, "type") + } +} + +func (p *UpdateGpuDeviceParams) GetType() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["type"].(string) + return value, ok +} + +func (p *UpdateGpuDeviceParams) SetVgpuprofileid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vgpuprofileid"] = v +} + +func (p *UpdateGpuDeviceParams) ResetVgpuprofileid() { + if p.p != nil && p.p["vgpuprofileid"] != nil { + delete(p.p, "vgpuprofileid") + } +} + +func (p *UpdateGpuDeviceParams) GetVgpuprofileid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vgpuprofileid"].(string) + return value, ok +} + +// You should always use this function to get a new UpdateGpuDeviceParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewUpdateGpuDeviceParams(id string) *UpdateGpuDeviceParams { + p := &UpdateGpuDeviceParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Updates an existing GPU device +func (s *GPUService) UpdateGpuDevice(p *UpdateGpuDeviceParams) (*UpdateGpuDeviceResponse, error) { + resp, err := s.cs.newPostRequest("updateGpuDevice", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateGpuDeviceResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UpdateGpuDeviceResponse struct { + Busaddress string `json:"busaddress"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpudevicetype string `json:"gpudevicetype"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Managedstate string `json:"managedstate"` + Numanode string `json:"numanode"` + Parentgpudeviceid string `json:"parentgpudeviceid"` + State string `json:"state"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Vmstate string `json:"vmstate"` +} + +type UpdateVgpuProfileParams struct { + p map[string]interface{} +} + +func (p *UpdateVgpuProfileParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["maxheads"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxheads", vv) + } + if v, found := p.p["maxresolutionx"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxresolutionx", vv) + } + if v, found := p.p["maxresolutiony"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxresolutiony", vv) + } + if v, found := p.p["maxvgpuperphysicalgpu"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxvgpuperphysicalgpu", vv) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["videoram"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("videoram", vv) + } + return u +} + +func (p *UpdateVgpuProfileParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *UpdateVgpuProfileParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *UpdateVgpuProfileParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *UpdateVgpuProfileParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *UpdateVgpuProfileParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *UpdateVgpuProfileParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *UpdateVgpuProfileParams) SetMaxheads(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxheads"] = v +} + +func (p *UpdateVgpuProfileParams) ResetMaxheads() { + if p.p != nil && p.p["maxheads"] != nil { + delete(p.p, "maxheads") + } +} + +func (p *UpdateVgpuProfileParams) GetMaxheads() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxheads"].(int64) + return value, ok +} + +func (p *UpdateVgpuProfileParams) SetMaxresolutionx(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxresolutionx"] = v +} + +func (p *UpdateVgpuProfileParams) ResetMaxresolutionx() { + if p.p != nil && p.p["maxresolutionx"] != nil { + delete(p.p, "maxresolutionx") + } +} + +func (p *UpdateVgpuProfileParams) GetMaxresolutionx() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxresolutionx"].(int64) + return value, ok +} + +func (p *UpdateVgpuProfileParams) SetMaxresolutiony(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxresolutiony"] = v +} + +func (p *UpdateVgpuProfileParams) ResetMaxresolutiony() { + if p.p != nil && p.p["maxresolutiony"] != nil { + delete(p.p, "maxresolutiony") + } +} + +func (p *UpdateVgpuProfileParams) GetMaxresolutiony() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxresolutiony"].(int64) + return value, ok +} + +func (p *UpdateVgpuProfileParams) SetMaxvgpuperphysicalgpu(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxvgpuperphysicalgpu"] = v +} + +func (p *UpdateVgpuProfileParams) ResetMaxvgpuperphysicalgpu() { + if p.p != nil && p.p["maxvgpuperphysicalgpu"] != nil { + delete(p.p, "maxvgpuperphysicalgpu") + } +} + +func (p *UpdateVgpuProfileParams) GetMaxvgpuperphysicalgpu() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxvgpuperphysicalgpu"].(int64) + return value, ok +} + +func (p *UpdateVgpuProfileParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *UpdateVgpuProfileParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *UpdateVgpuProfileParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *UpdateVgpuProfileParams) SetVideoram(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["videoram"] = v +} + +func (p *UpdateVgpuProfileParams) ResetVideoram() { + if p.p != nil && p.p["videoram"] != nil { + delete(p.p, "videoram") + } +} + +func (p *UpdateVgpuProfileParams) GetVideoram() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["videoram"].(int64) + return value, ok +} + +// You should always use this function to get a new UpdateVgpuProfileParams instance, +// as then you are sure you have configured all required params +func (s *GPUService) NewUpdateVgpuProfileParams(id string) *UpdateVgpuProfileParams { + p := &UpdateVgpuProfileParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Updates a vGPU profile in the system +func (s *GPUService) UpdateVgpuProfile(p *UpdateVgpuProfileParams) (*UpdateVgpuProfileResponse, error) { + resp, err := s.cs.newPostRequest("updateVgpuProfile", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateVgpuProfileResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UpdateVgpuProfileResponse struct { + Description string `json:"description"` + Deviceid string `json:"deviceid"` + Devicename string `json:"devicename"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` + Maxvgpuperphysicalgpu int64 `json:"maxvgpuperphysicalgpu"` + Name string `json:"name"` + Vendorid string `json:"vendorid"` + Vendorname string `json:"vendorname"` + Videoram int64 `json:"videoram"` +} diff --git a/cloudstack/GPUService_mock.go b/cloudstack/GPUService_mock.go new file mode 100644 index 00000000..b6e24323 --- /dev/null +++ b/cloudstack/GPUService_mock.go @@ -0,0 +1,641 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +// Code generated by MockGen. DO NOT EDIT. +// Source: ./cloudstack/GPUService.go +// +// Generated by this command: +// +// mockgen -destination=./cloudstack/GPUService_mock.go -package=cloudstack -copyright_file=header.txt -source=./cloudstack/GPUService.go +// + +// Package cloudstack is a generated GoMock package. +package cloudstack + +import ( + reflect "reflect" + + gomock "go.uber.org/mock/gomock" +) + +// MockGPUServiceIface is a mock of GPUServiceIface interface. +type MockGPUServiceIface struct { + ctrl *gomock.Controller + recorder *MockGPUServiceIfaceMockRecorder + isgomock struct{} +} + +// MockGPUServiceIfaceMockRecorder is the mock recorder for MockGPUServiceIface. +type MockGPUServiceIfaceMockRecorder struct { + mock *MockGPUServiceIface +} + +// NewMockGPUServiceIface creates a new mock instance. +func NewMockGPUServiceIface(ctrl *gomock.Controller) *MockGPUServiceIface { + mock := &MockGPUServiceIface{ctrl: ctrl} + mock.recorder = &MockGPUServiceIfaceMockRecorder{mock} + return mock +} + +// EXPECT returns an object that allows the caller to indicate expected use. +func (m *MockGPUServiceIface) EXPECT() *MockGPUServiceIfaceMockRecorder { + return m.recorder +} + +// CreateGpuCard mocks base method. +func (m *MockGPUServiceIface) CreateGpuCard(p *CreateGpuCardParams) (*CreateGpuCardResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateGpuCard", p) + ret0, _ := ret[0].(*CreateGpuCardResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateGpuCard indicates an expected call of CreateGpuCard. +func (mr *MockGPUServiceIfaceMockRecorder) CreateGpuCard(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateGpuCard", reflect.TypeOf((*MockGPUServiceIface)(nil).CreateGpuCard), p) +} + +// CreateGpuDevice mocks base method. +func (m *MockGPUServiceIface) CreateGpuDevice(p *CreateGpuDeviceParams) (*CreateGpuDeviceResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateGpuDevice", p) + ret0, _ := ret[0].(*CreateGpuDeviceResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateGpuDevice indicates an expected call of CreateGpuDevice. +func (mr *MockGPUServiceIfaceMockRecorder) CreateGpuDevice(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateGpuDevice", reflect.TypeOf((*MockGPUServiceIface)(nil).CreateGpuDevice), p) +} + +// CreateVgpuProfile mocks base method. +func (m *MockGPUServiceIface) CreateVgpuProfile(p *CreateVgpuProfileParams) (*CreateVgpuProfileResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateVgpuProfile", p) + ret0, _ := ret[0].(*CreateVgpuProfileResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateVgpuProfile indicates an expected call of CreateVgpuProfile. +func (mr *MockGPUServiceIfaceMockRecorder) CreateVgpuProfile(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateVgpuProfile", reflect.TypeOf((*MockGPUServiceIface)(nil).CreateVgpuProfile), p) +} + +// DeleteGpuCard mocks base method. +func (m *MockGPUServiceIface) DeleteGpuCard(p *DeleteGpuCardParams) (*DeleteGpuCardResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteGpuCard", p) + ret0, _ := ret[0].(*DeleteGpuCardResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteGpuCard indicates an expected call of DeleteGpuCard. +func (mr *MockGPUServiceIfaceMockRecorder) DeleteGpuCard(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteGpuCard", reflect.TypeOf((*MockGPUServiceIface)(nil).DeleteGpuCard), p) +} + +// DeleteGpuDevice mocks base method. +func (m *MockGPUServiceIface) DeleteGpuDevice(p *DeleteGpuDeviceParams) (*DeleteGpuDeviceResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteGpuDevice", p) + ret0, _ := ret[0].(*DeleteGpuDeviceResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteGpuDevice indicates an expected call of DeleteGpuDevice. +func (mr *MockGPUServiceIfaceMockRecorder) DeleteGpuDevice(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteGpuDevice", reflect.TypeOf((*MockGPUServiceIface)(nil).DeleteGpuDevice), p) +} + +// DeleteVgpuProfile mocks base method. +func (m *MockGPUServiceIface) DeleteVgpuProfile(p *DeleteVgpuProfileParams) (*DeleteVgpuProfileResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteVgpuProfile", p) + ret0, _ := ret[0].(*DeleteVgpuProfileResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteVgpuProfile indicates an expected call of DeleteVgpuProfile. +func (mr *MockGPUServiceIfaceMockRecorder) DeleteVgpuProfile(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteVgpuProfile", reflect.TypeOf((*MockGPUServiceIface)(nil).DeleteVgpuProfile), p) +} + +// DiscoverGpuDevices mocks base method. +func (m *MockGPUServiceIface) DiscoverGpuDevices(p *DiscoverGpuDevicesParams) (*DiscoverGpuDevicesResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DiscoverGpuDevices", p) + ret0, _ := ret[0].(*DiscoverGpuDevicesResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DiscoverGpuDevices indicates an expected call of DiscoverGpuDevices. +func (mr *MockGPUServiceIfaceMockRecorder) DiscoverGpuDevices(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DiscoverGpuDevices", reflect.TypeOf((*MockGPUServiceIface)(nil).DiscoverGpuDevices), p) +} + +// GetGpuCardByID mocks base method. +func (m *MockGPUServiceIface) GetGpuCardByID(id string, opts ...OptionFunc) (*GpuCard, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetGpuCardByID", varargs...) + ret0, _ := ret[0].(*GpuCard) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetGpuCardByID indicates an expected call of GetGpuCardByID. +func (mr *MockGPUServiceIfaceMockRecorder) GetGpuCardByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetGpuCardByID", reflect.TypeOf((*MockGPUServiceIface)(nil).GetGpuCardByID), varargs...) +} + +// GetGpuCardByName mocks base method. +func (m *MockGPUServiceIface) GetGpuCardByName(name string, opts ...OptionFunc) (*GpuCard, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetGpuCardByName", varargs...) + ret0, _ := ret[0].(*GpuCard) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetGpuCardByName indicates an expected call of GetGpuCardByName. +func (mr *MockGPUServiceIfaceMockRecorder) GetGpuCardByName(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetGpuCardByName", reflect.TypeOf((*MockGPUServiceIface)(nil).GetGpuCardByName), varargs...) +} + +// GetGpuCardID mocks base method. +func (m *MockGPUServiceIface) GetGpuCardID(keyword string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{keyword} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetGpuCardID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetGpuCardID indicates an expected call of GetGpuCardID. +func (mr *MockGPUServiceIfaceMockRecorder) GetGpuCardID(keyword any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{keyword}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetGpuCardID", reflect.TypeOf((*MockGPUServiceIface)(nil).GetGpuCardID), varargs...) +} + +// GetGpuDeviceByID mocks base method. +func (m *MockGPUServiceIface) GetGpuDeviceByID(id string, opts ...OptionFunc) (*GpuDevice, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetGpuDeviceByID", varargs...) + ret0, _ := ret[0].(*GpuDevice) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetGpuDeviceByID indicates an expected call of GetGpuDeviceByID. +func (mr *MockGPUServiceIfaceMockRecorder) GetGpuDeviceByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetGpuDeviceByID", reflect.TypeOf((*MockGPUServiceIface)(nil).GetGpuDeviceByID), varargs...) +} + +// GetVgpuProfileByID mocks base method. +func (m *MockGPUServiceIface) GetVgpuProfileByID(id string, opts ...OptionFunc) (*VgpuProfile, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetVgpuProfileByID", varargs...) + ret0, _ := ret[0].(*VgpuProfile) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetVgpuProfileByID indicates an expected call of GetVgpuProfileByID. +func (mr *MockGPUServiceIfaceMockRecorder) GetVgpuProfileByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetVgpuProfileByID", reflect.TypeOf((*MockGPUServiceIface)(nil).GetVgpuProfileByID), varargs...) +} + +// GetVgpuProfileByName mocks base method. +func (m *MockGPUServiceIface) GetVgpuProfileByName(name string, opts ...OptionFunc) (*VgpuProfile, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetVgpuProfileByName", varargs...) + ret0, _ := ret[0].(*VgpuProfile) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetVgpuProfileByName indicates an expected call of GetVgpuProfileByName. +func (mr *MockGPUServiceIfaceMockRecorder) GetVgpuProfileByName(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetVgpuProfileByName", reflect.TypeOf((*MockGPUServiceIface)(nil).GetVgpuProfileByName), varargs...) +} + +// GetVgpuProfileID mocks base method. +func (m *MockGPUServiceIface) GetVgpuProfileID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetVgpuProfileID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetVgpuProfileID indicates an expected call of GetVgpuProfileID. +func (mr *MockGPUServiceIfaceMockRecorder) GetVgpuProfileID(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetVgpuProfileID", reflect.TypeOf((*MockGPUServiceIface)(nil).GetVgpuProfileID), varargs...) +} + +// ListGpuCards mocks base method. +func (m *MockGPUServiceIface) ListGpuCards(p *ListGpuCardsParams) (*ListGpuCardsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListGpuCards", p) + ret0, _ := ret[0].(*ListGpuCardsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListGpuCards indicates an expected call of ListGpuCards. +func (mr *MockGPUServiceIfaceMockRecorder) ListGpuCards(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListGpuCards", reflect.TypeOf((*MockGPUServiceIface)(nil).ListGpuCards), p) +} + +// ListGpuDevices mocks base method. +func (m *MockGPUServiceIface) ListGpuDevices(p *ListGpuDevicesParams) (*ListGpuDevicesResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListGpuDevices", p) + ret0, _ := ret[0].(*ListGpuDevicesResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListGpuDevices indicates an expected call of ListGpuDevices. +func (mr *MockGPUServiceIfaceMockRecorder) ListGpuDevices(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListGpuDevices", reflect.TypeOf((*MockGPUServiceIface)(nil).ListGpuDevices), p) +} + +// ListVgpuProfiles mocks base method. +func (m *MockGPUServiceIface) ListVgpuProfiles(p *ListVgpuProfilesParams) (*ListVgpuProfilesResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListVgpuProfiles", p) + ret0, _ := ret[0].(*ListVgpuProfilesResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListVgpuProfiles indicates an expected call of ListVgpuProfiles. +func (mr *MockGPUServiceIfaceMockRecorder) ListVgpuProfiles(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListVgpuProfiles", reflect.TypeOf((*MockGPUServiceIface)(nil).ListVgpuProfiles), p) +} + +// ManageGpuDevice mocks base method. +func (m *MockGPUServiceIface) ManageGpuDevice(p *ManageGpuDeviceParams) (*ManageGpuDeviceResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ManageGpuDevice", p) + ret0, _ := ret[0].(*ManageGpuDeviceResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ManageGpuDevice indicates an expected call of ManageGpuDevice. +func (mr *MockGPUServiceIfaceMockRecorder) ManageGpuDevice(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ManageGpuDevice", reflect.TypeOf((*MockGPUServiceIface)(nil).ManageGpuDevice), p) +} + +// NewCreateGpuCardParams mocks base method. +func (m *MockGPUServiceIface) NewCreateGpuCardParams(deviceid, devicename, name, vendorid, vendorname string) *CreateGpuCardParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateGpuCardParams", deviceid, devicename, name, vendorid, vendorname) + ret0, _ := ret[0].(*CreateGpuCardParams) + return ret0 +} + +// NewCreateGpuCardParams indicates an expected call of NewCreateGpuCardParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewCreateGpuCardParams(deviceid, devicename, name, vendorid, vendorname any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateGpuCardParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewCreateGpuCardParams), deviceid, devicename, name, vendorid, vendorname) +} + +// NewCreateGpuDeviceParams mocks base method. +func (m *MockGPUServiceIface) NewCreateGpuDeviceParams(busaddress, gpucardid, hostid, vgpuprofileid string) *CreateGpuDeviceParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateGpuDeviceParams", busaddress, gpucardid, hostid, vgpuprofileid) + ret0, _ := ret[0].(*CreateGpuDeviceParams) + return ret0 +} + +// NewCreateGpuDeviceParams indicates an expected call of NewCreateGpuDeviceParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewCreateGpuDeviceParams(busaddress, gpucardid, hostid, vgpuprofileid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateGpuDeviceParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewCreateGpuDeviceParams), busaddress, gpucardid, hostid, vgpuprofileid) +} + +// NewCreateVgpuProfileParams mocks base method. +func (m *MockGPUServiceIface) NewCreateVgpuProfileParams(gpucardid, name string) *CreateVgpuProfileParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateVgpuProfileParams", gpucardid, name) + ret0, _ := ret[0].(*CreateVgpuProfileParams) + return ret0 +} + +// NewCreateVgpuProfileParams indicates an expected call of NewCreateVgpuProfileParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewCreateVgpuProfileParams(gpucardid, name any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateVgpuProfileParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewCreateVgpuProfileParams), gpucardid, name) +} + +// NewDeleteGpuCardParams mocks base method. +func (m *MockGPUServiceIface) NewDeleteGpuCardParams(id string) *DeleteGpuCardParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteGpuCardParams", id) + ret0, _ := ret[0].(*DeleteGpuCardParams) + return ret0 +} + +// NewDeleteGpuCardParams indicates an expected call of NewDeleteGpuCardParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewDeleteGpuCardParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteGpuCardParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewDeleteGpuCardParams), id) +} + +// NewDeleteGpuDeviceParams mocks base method. +func (m *MockGPUServiceIface) NewDeleteGpuDeviceParams(ids []string) *DeleteGpuDeviceParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteGpuDeviceParams", ids) + ret0, _ := ret[0].(*DeleteGpuDeviceParams) + return ret0 +} + +// NewDeleteGpuDeviceParams indicates an expected call of NewDeleteGpuDeviceParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewDeleteGpuDeviceParams(ids any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteGpuDeviceParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewDeleteGpuDeviceParams), ids) +} + +// NewDeleteVgpuProfileParams mocks base method. +func (m *MockGPUServiceIface) NewDeleteVgpuProfileParams(id string) *DeleteVgpuProfileParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteVgpuProfileParams", id) + ret0, _ := ret[0].(*DeleteVgpuProfileParams) + return ret0 +} + +// NewDeleteVgpuProfileParams indicates an expected call of NewDeleteVgpuProfileParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewDeleteVgpuProfileParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteVgpuProfileParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewDeleteVgpuProfileParams), id) +} + +// NewDiscoverGpuDevicesParams mocks base method. +func (m *MockGPUServiceIface) NewDiscoverGpuDevicesParams(id string) *DiscoverGpuDevicesParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDiscoverGpuDevicesParams", id) + ret0, _ := ret[0].(*DiscoverGpuDevicesParams) + return ret0 +} + +// NewDiscoverGpuDevicesParams indicates an expected call of NewDiscoverGpuDevicesParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewDiscoverGpuDevicesParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDiscoverGpuDevicesParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewDiscoverGpuDevicesParams), id) +} + +// NewListGpuCardsParams mocks base method. +func (m *MockGPUServiceIface) NewListGpuCardsParams() *ListGpuCardsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListGpuCardsParams") + ret0, _ := ret[0].(*ListGpuCardsParams) + return ret0 +} + +// NewListGpuCardsParams indicates an expected call of NewListGpuCardsParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewListGpuCardsParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListGpuCardsParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewListGpuCardsParams)) +} + +// NewListGpuDevicesParams mocks base method. +func (m *MockGPUServiceIface) NewListGpuDevicesParams() *ListGpuDevicesParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListGpuDevicesParams") + ret0, _ := ret[0].(*ListGpuDevicesParams) + return ret0 +} + +// NewListGpuDevicesParams indicates an expected call of NewListGpuDevicesParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewListGpuDevicesParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListGpuDevicesParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewListGpuDevicesParams)) +} + +// NewListVgpuProfilesParams mocks base method. +func (m *MockGPUServiceIface) NewListVgpuProfilesParams() *ListVgpuProfilesParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListVgpuProfilesParams") + ret0, _ := ret[0].(*ListVgpuProfilesParams) + return ret0 +} + +// NewListVgpuProfilesParams indicates an expected call of NewListVgpuProfilesParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewListVgpuProfilesParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListVgpuProfilesParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewListVgpuProfilesParams)) +} + +// NewManageGpuDeviceParams mocks base method. +func (m *MockGPUServiceIface) NewManageGpuDeviceParams(ids []string) *ManageGpuDeviceParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewManageGpuDeviceParams", ids) + ret0, _ := ret[0].(*ManageGpuDeviceParams) + return ret0 +} + +// NewManageGpuDeviceParams indicates an expected call of NewManageGpuDeviceParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewManageGpuDeviceParams(ids any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewManageGpuDeviceParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewManageGpuDeviceParams), ids) +} + +// NewUnmanageGpuDeviceParams mocks base method. +func (m *MockGPUServiceIface) NewUnmanageGpuDeviceParams(ids []string) *UnmanageGpuDeviceParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUnmanageGpuDeviceParams", ids) + ret0, _ := ret[0].(*UnmanageGpuDeviceParams) + return ret0 +} + +// NewUnmanageGpuDeviceParams indicates an expected call of NewUnmanageGpuDeviceParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewUnmanageGpuDeviceParams(ids any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUnmanageGpuDeviceParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewUnmanageGpuDeviceParams), ids) +} + +// NewUpdateGpuCardParams mocks base method. +func (m *MockGPUServiceIface) NewUpdateGpuCardParams(id string) *UpdateGpuCardParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateGpuCardParams", id) + ret0, _ := ret[0].(*UpdateGpuCardParams) + return ret0 +} + +// NewUpdateGpuCardParams indicates an expected call of NewUpdateGpuCardParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewUpdateGpuCardParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateGpuCardParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewUpdateGpuCardParams), id) +} + +// NewUpdateGpuDeviceParams mocks base method. +func (m *MockGPUServiceIface) NewUpdateGpuDeviceParams(id string) *UpdateGpuDeviceParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateGpuDeviceParams", id) + ret0, _ := ret[0].(*UpdateGpuDeviceParams) + return ret0 +} + +// NewUpdateGpuDeviceParams indicates an expected call of NewUpdateGpuDeviceParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewUpdateGpuDeviceParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateGpuDeviceParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewUpdateGpuDeviceParams), id) +} + +// NewUpdateVgpuProfileParams mocks base method. +func (m *MockGPUServiceIface) NewUpdateVgpuProfileParams(id string) *UpdateVgpuProfileParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateVgpuProfileParams", id) + ret0, _ := ret[0].(*UpdateVgpuProfileParams) + return ret0 +} + +// NewUpdateVgpuProfileParams indicates an expected call of NewUpdateVgpuProfileParams. +func (mr *MockGPUServiceIfaceMockRecorder) NewUpdateVgpuProfileParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateVgpuProfileParams", reflect.TypeOf((*MockGPUServiceIface)(nil).NewUpdateVgpuProfileParams), id) +} + +// UnmanageGpuDevice mocks base method. +func (m *MockGPUServiceIface) UnmanageGpuDevice(p *UnmanageGpuDeviceParams) (*UnmanageGpuDeviceResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UnmanageGpuDevice", p) + ret0, _ := ret[0].(*UnmanageGpuDeviceResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UnmanageGpuDevice indicates an expected call of UnmanageGpuDevice. +func (mr *MockGPUServiceIfaceMockRecorder) UnmanageGpuDevice(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UnmanageGpuDevice", reflect.TypeOf((*MockGPUServiceIface)(nil).UnmanageGpuDevice), p) +} + +// UpdateGpuCard mocks base method. +func (m *MockGPUServiceIface) UpdateGpuCard(p *UpdateGpuCardParams) (*UpdateGpuCardResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateGpuCard", p) + ret0, _ := ret[0].(*UpdateGpuCardResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateGpuCard indicates an expected call of UpdateGpuCard. +func (mr *MockGPUServiceIfaceMockRecorder) UpdateGpuCard(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateGpuCard", reflect.TypeOf((*MockGPUServiceIface)(nil).UpdateGpuCard), p) +} + +// UpdateGpuDevice mocks base method. +func (m *MockGPUServiceIface) UpdateGpuDevice(p *UpdateGpuDeviceParams) (*UpdateGpuDeviceResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateGpuDevice", p) + ret0, _ := ret[0].(*UpdateGpuDeviceResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateGpuDevice indicates an expected call of UpdateGpuDevice. +func (mr *MockGPUServiceIfaceMockRecorder) UpdateGpuDevice(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateGpuDevice", reflect.TypeOf((*MockGPUServiceIface)(nil).UpdateGpuDevice), p) +} + +// UpdateVgpuProfile mocks base method. +func (m *MockGPUServiceIface) UpdateVgpuProfile(p *UpdateVgpuProfileParams) (*UpdateVgpuProfileResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateVgpuProfile", p) + ret0, _ := ret[0].(*UpdateVgpuProfileResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateVgpuProfile indicates an expected call of UpdateVgpuProfile. +func (mr *MockGPUServiceIfaceMockRecorder) UpdateVgpuProfile(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateVgpuProfile", reflect.TypeOf((*MockGPUServiceIface)(nil).UpdateVgpuProfile), p) +} diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index ee8df3c5..d7d0d4ce 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -126,6 +126,7 @@ type CloudStackClient struct { Domain DomainServiceIface Event EventServiceIface Firewall FirewallServiceIface + GPU GPUServiceIface GuestOS GuestOSServiceIface Host HostServiceIface Hypervisor HypervisorServiceIface @@ -253,6 +254,7 @@ func newClient(apiurl string, apikey string, secret string, async bool, verifyss cs.Domain = NewDomainService(cs) cs.Event = NewEventService(cs) cs.Firewall = NewFirewallService(cs) + cs.GPU = NewGPUService(cs) cs.GuestOS = NewGuestOSService(cs) cs.Host = NewHostService(cs) cs.Hypervisor = NewHypervisorService(cs) @@ -353,6 +355,7 @@ func newMockClient(ctrl *gomock.Controller) *CloudStackClient { cs.Domain = NewMockDomainServiceIface(ctrl) cs.Event = NewMockEventServiceIface(ctrl) cs.Firewall = NewMockFirewallServiceIface(ctrl) + cs.GPU = NewMockGPUServiceIface(ctrl) cs.GuestOS = NewMockGuestOSServiceIface(ctrl) cs.Host = NewMockHostServiceIface(ctrl) cs.Hypervisor = NewMockHypervisorServiceIface(ctrl) @@ -1020,6 +1023,14 @@ func NewFirewallService(cs *CloudStackClient) FirewallServiceIface { return &FirewallService{cs: cs} } +type GPUService struct { + cs *CloudStackClient +} + +func NewGPUService(cs *CloudStackClient) GPUServiceIface { + return &GPUService{cs: cs} +} + type GuestOSService struct { cs *CloudStackClient } diff --git a/generate/layout.go b/generate/layout.go index a878a67a..35da4107 100644 --- a/generate/layout.go +++ b/generate/layout.go @@ -398,6 +398,23 @@ var layout = apiInfo{ "validateUserTwoFactorAuthenticationCode", "verifyOAuthCodeAndGetUser", }, + "GPUService": { + "createGpuCard", + "createGpuDevice", + "createVgpuProfile", + "deleteGpuCard", + "deleteGpuDevice", + "deleteVgpuProfile", + "discoverGpuDevices", + "listGpuCards", + "listGpuDevices", + "listVgpuProfiles", + "manageGpuDevice", + "unmanageGpuDevice", + "updateGpuCard", + "updateGpuDevice", + "updateVgpuProfile", + }, "LDAPService": { "addLdapConfiguration", "deleteLdapConfiguration", diff --git a/test/GPUService_test.go b/test/GPUService_test.go new file mode 100644 index 00000000..7ff2d341 --- /dev/null +++ b/test/GPUService_test.go @@ -0,0 +1,239 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package test + +import ( + "testing" + + "github.com/apache/cloudstack-go/v2/cloudstack" +) + +func TestGPUService(t *testing.T) { + service := "GPUService" + response, err := readData(service) + if err != nil { + t.Skipf("Skipping test as %v", err) + } + server := CreateTestServer(t, response) + client := cloudstack.NewClient(server.URL, "APIKEY", "SECRETKEY", true) + defer server.Close() + + testcreateGpuCard := func(t *testing.T) { + if _, ok := response["createGpuCard"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewCreateGpuCardParams("deviceid", "devicename", "name", "vendorid", "vendorname") + r, err := client.GPU.CreateGpuCard(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("CreateGpuCard", testcreateGpuCard) + + testcreateGpuDevice := func(t *testing.T) { + if _, ok := response["createGpuDevice"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewCreateGpuDeviceParams("busaddress", "gpucardid", "hostid", "vgpuprofileid") + r, err := client.GPU.CreateGpuDevice(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("CreateGpuDevice", testcreateGpuDevice) + + testcreateVgpuProfile := func(t *testing.T) { + if _, ok := response["createVgpuProfile"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewCreateVgpuProfileParams("gpucardid", "name") + r, err := client.GPU.CreateVgpuProfile(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("CreateVgpuProfile", testcreateVgpuProfile) + + testdeleteGpuCard := func(t *testing.T) { + if _, ok := response["deleteGpuCard"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewDeleteGpuCardParams("id") + _, err := client.GPU.DeleteGpuCard(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteGpuCard", testdeleteGpuCard) + + testdeleteGpuDevice := func(t *testing.T) { + if _, ok := response["deleteGpuDevice"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewDeleteGpuDeviceParams([]string{}) + _, err := client.GPU.DeleteGpuDevice(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteGpuDevice", testdeleteGpuDevice) + + testdeleteVgpuProfile := func(t *testing.T) { + if _, ok := response["deleteVgpuProfile"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewDeleteVgpuProfileParams("id") + _, err := client.GPU.DeleteVgpuProfile(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteVgpuProfile", testdeleteVgpuProfile) + + testdiscoverGpuDevices := func(t *testing.T) { + if _, ok := response["discoverGpuDevices"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewDiscoverGpuDevicesParams("id") + r, err := client.GPU.DiscoverGpuDevices(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("DiscoverGpuDevices", testdiscoverGpuDevices) + + testlistGpuCards := func(t *testing.T) { + if _, ok := response["listGpuCards"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewListGpuCardsParams() + _, err := client.GPU.ListGpuCards(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListGpuCards", testlistGpuCards) + + testlistGpuDevices := func(t *testing.T) { + if _, ok := response["listGpuDevices"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewListGpuDevicesParams() + _, err := client.GPU.ListGpuDevices(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListGpuDevices", testlistGpuDevices) + + testlistVgpuProfiles := func(t *testing.T) { + if _, ok := response["listVgpuProfiles"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewListVgpuProfilesParams() + _, err := client.GPU.ListVgpuProfiles(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListVgpuProfiles", testlistVgpuProfiles) + + testmanageGpuDevice := func(t *testing.T) { + if _, ok := response["manageGpuDevice"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewManageGpuDeviceParams([]string{}) + _, err := client.GPU.ManageGpuDevice(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ManageGpuDevice", testmanageGpuDevice) + + testunmanageGpuDevice := func(t *testing.T) { + if _, ok := response["unmanageGpuDevice"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewUnmanageGpuDeviceParams([]string{}) + _, err := client.GPU.UnmanageGpuDevice(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("UnmanageGpuDevice", testunmanageGpuDevice) + + testupdateGpuCard := func(t *testing.T) { + if _, ok := response["updateGpuCard"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewUpdateGpuCardParams("id") + r, err := client.GPU.UpdateGpuCard(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UpdateGpuCard", testupdateGpuCard) + + testupdateGpuDevice := func(t *testing.T) { + if _, ok := response["updateGpuDevice"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewUpdateGpuDeviceParams("id") + r, err := client.GPU.UpdateGpuDevice(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UpdateGpuDevice", testupdateGpuDevice) + + testupdateVgpuProfile := func(t *testing.T) { + if _, ok := response["updateVgpuProfile"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.GPU.NewUpdateVgpuProfileParams("id") + r, err := client.GPU.UpdateVgpuProfile(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UpdateVgpuProfile", testupdateVgpuProfile) + +} From 7625abd51eab05df5663264b7ae7ddc6e36d5ac6 Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Tue, 23 Sep 2025 08:44:45 -0400 Subject: [PATCH 4/6] Add support to Cni config, Nsx, Netris service management and add additional k8s APIs support (#123) --- cloudstack/ConfigurationService.go | 775 ++++++++++++++++++++++++ cloudstack/ConfigurationService_mock.go | 150 +++++ cloudstack/KubernetesService.go | 368 +++++++++++ cloudstack/KubernetesService_mock.go | 58 ++ cloudstack/NetrisService.go | 507 ++++++++++++++++ cloudstack/NetrisService_mock.go | 146 +++++ cloudstack/NsxService.go | 534 ++++++++++++++++ cloudstack/NsxService_mock.go | 146 +++++ cloudstack/cloudstack.go | 22 + generate/layout.go | 15 + test/ConfigurationService_test.go | 36 ++ test/KubernetesService_test.go | 30 + test/NetrisService_test.go | 74 +++ test/NsxService_test.go | 74 +++ 14 files changed, 2935 insertions(+) create mode 100644 cloudstack/NetrisService.go create mode 100644 cloudstack/NetrisService_mock.go create mode 100644 cloudstack/NsxService.go create mode 100644 cloudstack/NsxService_mock.go create mode 100644 test/NetrisService_test.go create mode 100644 test/NsxService_test.go diff --git a/cloudstack/ConfigurationService.go b/cloudstack/ConfigurationService.go index e5275c06..914322da 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -21,8 +21,10 @@ package cloudstack import ( "encoding/json" + "fmt" "net/url" "strconv" + "strings" ) type ConfigurationServiceIface interface { @@ -40,6 +42,15 @@ type ConfigurationServiceIface interface { NewResetConfigurationParams(name string) *ResetConfigurationParams UpdateStorageCapabilities(p *UpdateStorageCapabilitiesParams) (*UpdateStorageCapabilitiesResponse, error) NewUpdateStorageCapabilitiesParams(id string) *UpdateStorageCapabilitiesParams + RegisterCniConfiguration(p *RegisterCniConfigurationParams) (*RegisterCniConfigurationResponse, error) + NewRegisterCniConfigurationParams(name string) *RegisterCniConfigurationParams + ListCniConfiguration(p *ListCniConfigurationParams) (*ListCniConfigurationResponse, error) + NewListCniConfigurationParams() *ListCniConfigurationParams + GetCniConfigurationID(name string, opts ...OptionFunc) (string, int, error) + GetCniConfigurationByName(name string, opts ...OptionFunc) (*CniConfiguration, int, error) + GetCniConfigurationByID(id string, opts ...OptionFunc) (*CniConfiguration, int, error) + DeleteCniConfiguration(p *DeleteCniConfigurationParams) (*DeleteCniConfigurationResponse, error) + NewDeleteCniConfigurationParams(id string) *DeleteCniConfigurationParams } type ListCapabilitiesParams struct { @@ -1360,3 +1371,767 @@ type UpdateStorageCapabilitiesResponse struct { Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } + +type RegisterCniConfigurationParams struct { + p map[string]interface{} +} + +func (p *RegisterCniConfigurationParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["cniconfig"]; found { + u.Set("cniconfig", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["params"]; found { + u.Set("params", v.(string)) + } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } + return u +} + +func (p *RegisterCniConfigurationParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *RegisterCniConfigurationParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *RegisterCniConfigurationParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *RegisterCniConfigurationParams) SetCniconfig(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cniconfig"] = v +} + +func (p *RegisterCniConfigurationParams) ResetCniconfig() { + if p.p != nil && p.p["cniconfig"] != nil { + delete(p.p, "cniconfig") + } +} + +func (p *RegisterCniConfigurationParams) GetCniconfig() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cniconfig"].(string) + return value, ok +} + +func (p *RegisterCniConfigurationParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *RegisterCniConfigurationParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *RegisterCniConfigurationParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *RegisterCniConfigurationParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *RegisterCniConfigurationParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *RegisterCniConfigurationParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *RegisterCniConfigurationParams) SetParams(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["params"] = v +} + +func (p *RegisterCniConfigurationParams) ResetParams() { + if p.p != nil && p.p["params"] != nil { + delete(p.p, "params") + } +} + +func (p *RegisterCniConfigurationParams) GetParams() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["params"].(string) + return value, ok +} + +func (p *RegisterCniConfigurationParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *RegisterCniConfigurationParams) ResetProjectid() { + if p.p != nil && p.p["projectid"] != nil { + delete(p.p, "projectid") + } +} + +func (p *RegisterCniConfigurationParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + +// You should always use this function to get a new RegisterCniConfigurationParams instance, +// as then you are sure you have configured all required params +func (s *ConfigurationService) NewRegisterCniConfigurationParams(name string) *RegisterCniConfigurationParams { + p := &RegisterCniConfigurationParams{} + p.p = make(map[string]interface{}) + p.p["name"] = name + return p +} + +// Register a CNI Configuration to be used with CKS cluster +func (s *ConfigurationService) RegisterCniConfiguration(p *RegisterCniConfigurationParams) (*RegisterCniConfigurationResponse, error) { + resp, err := s.cs.newPostRequest("registerCniConfiguration", p.toURLValues()) + if err != nil { + return nil, err + } + + var r RegisterCniConfigurationResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type RegisterCniConfigurationResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *RegisterCniConfigurationResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias RegisterCniConfigurationResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type ListCniConfigurationParams struct { + p map[string]interface{} +} + +func (p *ListCniConfigurationParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["isrecursive"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isrecursive", vv) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["listall"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listall", vv) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } + return u +} + +func (p *ListCniConfigurationParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *ListCniConfigurationParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *ListCniConfigurationParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *ListCniConfigurationParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *ListCniConfigurationParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *ListCniConfigurationParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *ListCniConfigurationParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListCniConfigurationParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListCniConfigurationParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListCniConfigurationParams) SetIsrecursive(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isrecursive"] = v +} + +func (p *ListCniConfigurationParams) ResetIsrecursive() { + if p.p != nil && p.p["isrecursive"] != nil { + delete(p.p, "isrecursive") + } +} + +func (p *ListCniConfigurationParams) GetIsrecursive() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isrecursive"].(bool) + return value, ok +} + +func (p *ListCniConfigurationParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListCniConfigurationParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListCniConfigurationParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListCniConfigurationParams) SetListall(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listall"] = v +} + +func (p *ListCniConfigurationParams) ResetListall() { + if p.p != nil && p.p["listall"] != nil { + delete(p.p, "listall") + } +} + +func (p *ListCniConfigurationParams) GetListall() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listall"].(bool) + return value, ok +} + +func (p *ListCniConfigurationParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListCniConfigurationParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ListCniConfigurationParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ListCniConfigurationParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListCniConfigurationParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListCniConfigurationParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListCniConfigurationParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListCniConfigurationParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListCniConfigurationParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListCniConfigurationParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListCniConfigurationParams) ResetProjectid() { + if p.p != nil && p.p["projectid"] != nil { + delete(p.p, "projectid") + } +} + +func (p *ListCniConfigurationParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + +// You should always use this function to get a new ListCniConfigurationParams instance, +// as then you are sure you have configured all required params +func (s *ConfigurationService) NewListCniConfigurationParams() *ListCniConfigurationParams { + p := &ListCniConfigurationParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ConfigurationService) GetCniConfigurationID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListCniConfigurationParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListCniConfiguration(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.CniConfiguration[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.CniConfiguration { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ConfigurationService) GetCniConfigurationByName(name string, opts ...OptionFunc) (*CniConfiguration, int, error) { + id, count, err := s.GetCniConfigurationID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetCniConfigurationByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ConfigurationService) GetCniConfigurationByID(id string, opts ...OptionFunc) (*CniConfiguration, int, error) { + p := &ListCniConfigurationParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListCniConfiguration(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.CniConfiguration[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for CniConfiguration UUID: %s!", id) +} + +// List user data for CNI plugins +func (s *ConfigurationService) ListCniConfiguration(p *ListCniConfigurationParams) (*ListCniConfigurationResponse, error) { + resp, err := s.cs.newRequest("listCniConfiguration", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListCniConfigurationResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListCniConfigurationResponse struct { + Count int `json:"count"` + CniConfiguration []*CniConfiguration `json:"cniconfiguration"` +} + +type CniConfiguration struct { + Account string `json:"account"` + Accountid string `json:"accountid"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Params string `json:"params"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Userdata string `json:"userdata"` +} + +type DeleteCniConfigurationParams struct { + p map[string]interface{} +} + +func (p *DeleteCniConfigurationParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } + return u +} + +func (p *DeleteCniConfigurationParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *DeleteCniConfigurationParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *DeleteCniConfigurationParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *DeleteCniConfigurationParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *DeleteCniConfigurationParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *DeleteCniConfigurationParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *DeleteCniConfigurationParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteCniConfigurationParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteCniConfigurationParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *DeleteCniConfigurationParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *DeleteCniConfigurationParams) ResetProjectid() { + if p.p != nil && p.p["projectid"] != nil { + delete(p.p, "projectid") + } +} + +func (p *DeleteCniConfigurationParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteCniConfigurationParams instance, +// as then you are sure you have configured all required params +func (s *ConfigurationService) NewDeleteCniConfigurationParams(id string) *DeleteCniConfigurationParams { + p := &DeleteCniConfigurationParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Deletes a CNI Configuration +func (s *ConfigurationService) DeleteCniConfiguration(p *DeleteCniConfigurationParams) (*DeleteCniConfigurationResponse, error) { + resp, err := s.cs.newPostRequest("deleteCniConfiguration", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteCniConfigurationResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteCniConfigurationResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *DeleteCniConfigurationResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias DeleteCniConfigurationResponse + return json.Unmarshal(b, (*alias)(r)) +} diff --git a/cloudstack/ConfigurationService_mock.go b/cloudstack/ConfigurationService_mock.go index e7efe3ea..668403ac 100644 --- a/cloudstack/ConfigurationService_mock.go +++ b/cloudstack/ConfigurationService_mock.go @@ -58,6 +58,84 @@ func (m *MockConfigurationServiceIface) EXPECT() *MockConfigurationServiceIfaceM return m.recorder } +// DeleteCniConfiguration mocks base method. +func (m *MockConfigurationServiceIface) DeleteCniConfiguration(p *DeleteCniConfigurationParams) (*DeleteCniConfigurationResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteCniConfiguration", p) + ret0, _ := ret[0].(*DeleteCniConfigurationResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteCniConfiguration indicates an expected call of DeleteCniConfiguration. +func (mr *MockConfigurationServiceIfaceMockRecorder) DeleteCniConfiguration(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteCniConfiguration", reflect.TypeOf((*MockConfigurationServiceIface)(nil).DeleteCniConfiguration), p) +} + +// GetCniConfigurationByID mocks base method. +func (m *MockConfigurationServiceIface) GetCniConfigurationByID(id string, opts ...OptionFunc) (*CniConfiguration, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetCniConfigurationByID", varargs...) + ret0, _ := ret[0].(*CniConfiguration) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetCniConfigurationByID indicates an expected call of GetCniConfigurationByID. +func (mr *MockConfigurationServiceIfaceMockRecorder) GetCniConfigurationByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetCniConfigurationByID", reflect.TypeOf((*MockConfigurationServiceIface)(nil).GetCniConfigurationByID), varargs...) +} + +// GetCniConfigurationByName mocks base method. +func (m *MockConfigurationServiceIface) GetCniConfigurationByName(name string, opts ...OptionFunc) (*CniConfiguration, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetCniConfigurationByName", varargs...) + ret0, _ := ret[0].(*CniConfiguration) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetCniConfigurationByName indicates an expected call of GetCniConfigurationByName. +func (mr *MockConfigurationServiceIfaceMockRecorder) GetCniConfigurationByName(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetCniConfigurationByName", reflect.TypeOf((*MockConfigurationServiceIface)(nil).GetCniConfigurationByName), varargs...) +} + +// GetCniConfigurationID mocks base method. +func (m *MockConfigurationServiceIface) GetCniConfigurationID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetCniConfigurationID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetCniConfigurationID indicates an expected call of GetCniConfigurationID. +func (mr *MockConfigurationServiceIfaceMockRecorder) GetCniConfigurationID(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetCniConfigurationID", reflect.TypeOf((*MockConfigurationServiceIface)(nil).GetCniConfigurationID), varargs...) +} + // ListCapabilities mocks base method. func (m *MockConfigurationServiceIface) ListCapabilities(p *ListCapabilitiesParams) (*ListCapabilitiesResponse, error) { m.ctrl.T.Helper() @@ -73,6 +151,21 @@ func (mr *MockConfigurationServiceIfaceMockRecorder) ListCapabilities(p any) *go return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListCapabilities", reflect.TypeOf((*MockConfigurationServiceIface)(nil).ListCapabilities), p) } +// ListCniConfiguration mocks base method. +func (m *MockConfigurationServiceIface) ListCniConfiguration(p *ListCniConfigurationParams) (*ListCniConfigurationResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListCniConfiguration", p) + ret0, _ := ret[0].(*ListCniConfigurationResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListCniConfiguration indicates an expected call of ListCniConfiguration. +func (mr *MockConfigurationServiceIfaceMockRecorder) ListCniConfiguration(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListCniConfiguration", reflect.TypeOf((*MockConfigurationServiceIface)(nil).ListCniConfiguration), p) +} + // ListConfigurationGroups mocks base method. func (m *MockConfigurationServiceIface) ListConfigurationGroups(p *ListConfigurationGroupsParams) (*ListConfigurationGroupsResponse, error) { m.ctrl.T.Helper() @@ -118,6 +211,20 @@ func (mr *MockConfigurationServiceIfaceMockRecorder) ListDeploymentPlanners(p an return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListDeploymentPlanners", reflect.TypeOf((*MockConfigurationServiceIface)(nil).ListDeploymentPlanners), p) } +// NewDeleteCniConfigurationParams mocks base method. +func (m *MockConfigurationServiceIface) NewDeleteCniConfigurationParams(id string) *DeleteCniConfigurationParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteCniConfigurationParams", id) + ret0, _ := ret[0].(*DeleteCniConfigurationParams) + return ret0 +} + +// NewDeleteCniConfigurationParams indicates an expected call of NewDeleteCniConfigurationParams. +func (mr *MockConfigurationServiceIfaceMockRecorder) NewDeleteCniConfigurationParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteCniConfigurationParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewDeleteCniConfigurationParams), id) +} + // NewListCapabilitiesParams mocks base method. func (m *MockConfigurationServiceIface) NewListCapabilitiesParams() *ListCapabilitiesParams { m.ctrl.T.Helper() @@ -132,6 +239,20 @@ func (mr *MockConfigurationServiceIfaceMockRecorder) NewListCapabilitiesParams() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListCapabilitiesParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewListCapabilitiesParams)) } +// NewListCniConfigurationParams mocks base method. +func (m *MockConfigurationServiceIface) NewListCniConfigurationParams() *ListCniConfigurationParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListCniConfigurationParams") + ret0, _ := ret[0].(*ListCniConfigurationParams) + return ret0 +} + +// NewListCniConfigurationParams indicates an expected call of NewListCniConfigurationParams. +func (mr *MockConfigurationServiceIfaceMockRecorder) NewListCniConfigurationParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListCniConfigurationParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewListCniConfigurationParams)) +} + // NewListConfigurationGroupsParams mocks base method. func (m *MockConfigurationServiceIface) NewListConfigurationGroupsParams() *ListConfigurationGroupsParams { m.ctrl.T.Helper() @@ -174,6 +295,20 @@ func (mr *MockConfigurationServiceIfaceMockRecorder) NewListDeploymentPlannersPa return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListDeploymentPlannersParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewListDeploymentPlannersParams)) } +// NewRegisterCniConfigurationParams mocks base method. +func (m *MockConfigurationServiceIface) NewRegisterCniConfigurationParams(name string) *RegisterCniConfigurationParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewRegisterCniConfigurationParams", name) + ret0, _ := ret[0].(*RegisterCniConfigurationParams) + return ret0 +} + +// NewRegisterCniConfigurationParams indicates an expected call of NewRegisterCniConfigurationParams. +func (mr *MockConfigurationServiceIfaceMockRecorder) NewRegisterCniConfigurationParams(name any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRegisterCniConfigurationParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewRegisterCniConfigurationParams), name) +} + // NewResetConfigurationParams mocks base method. func (m *MockConfigurationServiceIface) NewResetConfigurationParams(name string) *ResetConfigurationParams { m.ctrl.T.Helper() @@ -216,6 +351,21 @@ func (mr *MockConfigurationServiceIfaceMockRecorder) NewUpdateStorageCapabilitie return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateStorageCapabilitiesParams", reflect.TypeOf((*MockConfigurationServiceIface)(nil).NewUpdateStorageCapabilitiesParams), id) } +// RegisterCniConfiguration mocks base method. +func (m *MockConfigurationServiceIface) RegisterCniConfiguration(p *RegisterCniConfigurationParams) (*RegisterCniConfigurationResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "RegisterCniConfiguration", p) + ret0, _ := ret[0].(*RegisterCniConfigurationResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// RegisterCniConfiguration indicates an expected call of RegisterCniConfiguration. +func (mr *MockConfigurationServiceIfaceMockRecorder) RegisterCniConfiguration(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RegisterCniConfiguration", reflect.TypeOf((*MockConfigurationServiceIface)(nil).RegisterCniConfiguration), p) +} + // ResetConfiguration mocks base method. func (m *MockConfigurationServiceIface) ResetConfiguration(p *ResetConfigurationParams) (*ResetConfigurationResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index 35064e28..373ec6c1 100644 --- a/cloudstack/KubernetesService.go +++ b/cloudstack/KubernetesService.go @@ -62,6 +62,10 @@ type KubernetesServiceIface interface { NewAddVirtualMachinesToKubernetesClusterParams(id string, virtualmachineids []string) *AddVirtualMachinesToKubernetesClusterParams RemoveVirtualMachinesFromKubernetesCluster(p *RemoveVirtualMachinesFromKubernetesClusterParams) (*RemoveVirtualMachinesFromKubernetesClusterResponse, error) NewRemoveVirtualMachinesFromKubernetesClusterParams(id string, virtualmachineids []string) *RemoveVirtualMachinesFromKubernetesClusterParams + AddNodesToKubernetesCluster(p *AddNodesToKubernetesClusterParams) (*AddNodesToKubernetesClusterResponse, error) + NewAddNodesToKubernetesClusterParams(id string, nodeids []string) *AddNodesToKubernetesClusterParams + RemoveNodesFromKubernetesCluster(p *RemoveNodesFromKubernetesClusterParams) (*RemoveNodesFromKubernetesClusterResponse, error) + NewRemoveNodesFromKubernetesClusterParams(id string, nodeids []string) *RemoveNodesFromKubernetesClusterParams } type AddKubernetesSupportedVersionParams struct { @@ -3309,3 +3313,367 @@ func (r *RemoveVirtualMachinesFromKubernetesClusterResponse) UnmarshalJSON(b []b type alias RemoveVirtualMachinesFromKubernetesClusterResponse return json.Unmarshal(b, (*alias)(r)) } + +type AddNodesToKubernetesClusterParams struct { + p map[string]interface{} +} + +func (p *AddNodesToKubernetesClusterParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["manualupgrade"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("manualupgrade", vv) + } + if v, found := p.p["mountcksisoonvr"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("mountcksisoonvr", vv) + } + if v, found := p.p["nodeids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("nodeids", vv) + } + return u +} + +func (p *AddNodesToKubernetesClusterParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *AddNodesToKubernetesClusterParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *AddNodesToKubernetesClusterParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *AddNodesToKubernetesClusterParams) SetManualupgrade(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["manualupgrade"] = v +} + +func (p *AddNodesToKubernetesClusterParams) ResetManualupgrade() { + if p.p != nil && p.p["manualupgrade"] != nil { + delete(p.p, "manualupgrade") + } +} + +func (p *AddNodesToKubernetesClusterParams) GetManualupgrade() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["manualupgrade"].(bool) + return value, ok +} + +func (p *AddNodesToKubernetesClusterParams) SetMountcksisoonvr(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["mountcksisoonvr"] = v +} + +func (p *AddNodesToKubernetesClusterParams) ResetMountcksisoonvr() { + if p.p != nil && p.p["mountcksisoonvr"] != nil { + delete(p.p, "mountcksisoonvr") + } +} + +func (p *AddNodesToKubernetesClusterParams) GetMountcksisoonvr() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["mountcksisoonvr"].(bool) + return value, ok +} + +func (p *AddNodesToKubernetesClusterParams) SetNodeids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nodeids"] = v +} + +func (p *AddNodesToKubernetesClusterParams) ResetNodeids() { + if p.p != nil && p.p["nodeids"] != nil { + delete(p.p, "nodeids") + } +} + +func (p *AddNodesToKubernetesClusterParams) GetNodeids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nodeids"].([]string) + return value, ok +} + +// You should always use this function to get a new AddNodesToKubernetesClusterParams instance, +// as then you are sure you have configured all required params +func (s *KubernetesService) NewAddNodesToKubernetesClusterParams(id string, nodeids []string) *AddNodesToKubernetesClusterParams { + p := &AddNodesToKubernetesClusterParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + p.p["nodeids"] = nodeids + return p +} + +// Add nodes as workers to an existing CKS cluster. +func (s *KubernetesService) AddNodesToKubernetesCluster(p *AddNodesToKubernetesClusterParams) (*AddNodesToKubernetesClusterResponse, error) { + resp, err := s.cs.newPostRequest("addNodesToKubernetesCluster", p.toURLValues()) + if err != nil { + return nil, err + } + + var r AddNodesToKubernetesClusterResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type AddNodesToKubernetesClusterResponse struct { + Account string `json:"account"` + Associatednetworkname string `json:"associatednetworkname"` + Autoscalingenabled bool `json:"autoscalingenabled"` + Clustertype string `json:"clustertype"` + Cniconfigname string `json:"cniconfigname"` + Cniconfigurationid string `json:"cniconfigurationid"` + Consoleendpoint string `json:"consoleendpoint"` + Controlnodes int64 `json:"controlnodes"` + Controlofferingid string `json:"controlofferingid"` + Controlofferingname string `json:"controlofferingname"` + Cpunumber string `json:"cpunumber"` + Created string `json:"created"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Endpoint string `json:"endpoint"` + Etcdips map[string]string `json:"etcdips"` + Etcdnodes int64 `json:"etcdnodes"` + Etcdofferingid string `json:"etcdofferingid"` + Etcdofferingname string `json:"etcdofferingname"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Ipaddress string `json:"ipaddress"` + Ipaddressid string `json:"ipaddressid"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Keypair string `json:"keypair"` + Kubernetesversionid string `json:"kubernetesversionid"` + Kubernetesversionname string `json:"kubernetesversionname"` + Masternodes int64 `json:"masternodes"` + Maxsize int64 `json:"maxsize"` + Memory string `json:"memory"` + Minsize int64 `json:"minsize"` + Name string `json:"name"` + Networkid string `json:"networkid"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + State string `json:"state"` + Templateid string `json:"templateid"` + Virtualmachines []*VirtualMachine `json:"virtualmachines"` + Workerofferingid string `json:"workerofferingid"` + Workerofferingname string `json:"workerofferingname"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type RemoveNodesFromKubernetesClusterParams struct { + p map[string]interface{} +} + +func (p *RemoveNodesFromKubernetesClusterParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["nodeids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("nodeids", vv) + } + return u +} + +func (p *RemoveNodesFromKubernetesClusterParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *RemoveNodesFromKubernetesClusterParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *RemoveNodesFromKubernetesClusterParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *RemoveNodesFromKubernetesClusterParams) SetNodeids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nodeids"] = v +} + +func (p *RemoveNodesFromKubernetesClusterParams) ResetNodeids() { + if p.p != nil && p.p["nodeids"] != nil { + delete(p.p, "nodeids") + } +} + +func (p *RemoveNodesFromKubernetesClusterParams) GetNodeids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nodeids"].([]string) + return value, ok +} + +// You should always use this function to get a new RemoveNodesFromKubernetesClusterParams instance, +// as then you are sure you have configured all required params +func (s *KubernetesService) NewRemoveNodesFromKubernetesClusterParams(id string, nodeids []string) *RemoveNodesFromKubernetesClusterParams { + p := &RemoveNodesFromKubernetesClusterParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + p.p["nodeids"] = nodeids + return p +} + +// Removes external nodes from a CKS cluster. +func (s *KubernetesService) RemoveNodesFromKubernetesCluster(p *RemoveNodesFromKubernetesClusterParams) (*RemoveNodesFromKubernetesClusterResponse, error) { + resp, err := s.cs.newPostRequest("removeNodesFromKubernetesCluster", p.toURLValues()) + if err != nil { + return nil, err + } + + var r RemoveNodesFromKubernetesClusterResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type RemoveNodesFromKubernetesClusterResponse struct { + Account string `json:"account"` + Associatednetworkname string `json:"associatednetworkname"` + Autoscalingenabled bool `json:"autoscalingenabled"` + Clustertype string `json:"clustertype"` + Cniconfigname string `json:"cniconfigname"` + Cniconfigurationid string `json:"cniconfigurationid"` + Consoleendpoint string `json:"consoleendpoint"` + Controlnodes int64 `json:"controlnodes"` + Controlofferingid string `json:"controlofferingid"` + Controlofferingname string `json:"controlofferingname"` + Cpunumber string `json:"cpunumber"` + Created string `json:"created"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Endpoint string `json:"endpoint"` + Etcdips map[string]string `json:"etcdips"` + Etcdnodes int64 `json:"etcdnodes"` + Etcdofferingid string `json:"etcdofferingid"` + Etcdofferingname string `json:"etcdofferingname"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Ipaddress string `json:"ipaddress"` + Ipaddressid string `json:"ipaddressid"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Keypair string `json:"keypair"` + Kubernetesversionid string `json:"kubernetesversionid"` + Kubernetesversionname string `json:"kubernetesversionname"` + Masternodes int64 `json:"masternodes"` + Maxsize int64 `json:"maxsize"` + Memory string `json:"memory"` + Minsize int64 `json:"minsize"` + Name string `json:"name"` + Networkid string `json:"networkid"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + State string `json:"state"` + Templateid string `json:"templateid"` + Virtualmachines []*VirtualMachine `json:"virtualmachines"` + Workerofferingid string `json:"workerofferingid"` + Workerofferingname string `json:"workerofferingname"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} diff --git a/cloudstack/KubernetesService_mock.go b/cloudstack/KubernetesService_mock.go index 645f25b9..65dea25b 100644 --- a/cloudstack/KubernetesService_mock.go +++ b/cloudstack/KubernetesService_mock.go @@ -73,6 +73,21 @@ func (mr *MockKubernetesServiceIfaceMockRecorder) AddKubernetesSupportedVersion( return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddKubernetesSupportedVersion", reflect.TypeOf((*MockKubernetesServiceIface)(nil).AddKubernetesSupportedVersion), p) } +// AddNodesToKubernetesCluster mocks base method. +func (m *MockKubernetesServiceIface) AddNodesToKubernetesCluster(p *AddNodesToKubernetesClusterParams) (*AddNodesToKubernetesClusterResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "AddNodesToKubernetesCluster", p) + ret0, _ := ret[0].(*AddNodesToKubernetesClusterResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// AddNodesToKubernetesCluster indicates an expected call of AddNodesToKubernetesCluster. +func (mr *MockKubernetesServiceIfaceMockRecorder) AddNodesToKubernetesCluster(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddNodesToKubernetesCluster", reflect.TypeOf((*MockKubernetesServiceIface)(nil).AddNodesToKubernetesCluster), p) +} + // AddVirtualMachinesToKubernetesCluster mocks base method. func (m *MockKubernetesServiceIface) AddVirtualMachinesToKubernetesCluster(p *AddVirtualMachinesToKubernetesClusterParams) (*AddVirtualMachinesToKubernetesClusterResponse, error) { m.ctrl.T.Helper() @@ -318,6 +333,20 @@ func (mr *MockKubernetesServiceIfaceMockRecorder) NewAddKubernetesSupportedVersi return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAddKubernetesSupportedVersionParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewAddKubernetesSupportedVersionParams), mincpunumber, minmemory, semanticversion) } +// NewAddNodesToKubernetesClusterParams mocks base method. +func (m *MockKubernetesServiceIface) NewAddNodesToKubernetesClusterParams(id string, nodeids []string) *AddNodesToKubernetesClusterParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewAddNodesToKubernetesClusterParams", id, nodeids) + ret0, _ := ret[0].(*AddNodesToKubernetesClusterParams) + return ret0 +} + +// NewAddNodesToKubernetesClusterParams indicates an expected call of NewAddNodesToKubernetesClusterParams. +func (mr *MockKubernetesServiceIfaceMockRecorder) NewAddNodesToKubernetesClusterParams(id, nodeids any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAddNodesToKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewAddNodesToKubernetesClusterParams), id, nodeids) +} + // NewAddVirtualMachinesToKubernetesClusterParams mocks base method. func (m *MockKubernetesServiceIface) NewAddVirtualMachinesToKubernetesClusterParams(id string, virtualmachineids []string) *AddVirtualMachinesToKubernetesClusterParams { m.ctrl.T.Helper() @@ -416,6 +445,20 @@ func (mr *MockKubernetesServiceIfaceMockRecorder) NewListKubernetesSupportedVers return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListKubernetesSupportedVersionsParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewListKubernetesSupportedVersionsParams)) } +// NewRemoveNodesFromKubernetesClusterParams mocks base method. +func (m *MockKubernetesServiceIface) NewRemoveNodesFromKubernetesClusterParams(id string, nodeids []string) *RemoveNodesFromKubernetesClusterParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewRemoveNodesFromKubernetesClusterParams", id, nodeids) + ret0, _ := ret[0].(*RemoveNodesFromKubernetesClusterParams) + return ret0 +} + +// NewRemoveNodesFromKubernetesClusterParams indicates an expected call of NewRemoveNodesFromKubernetesClusterParams. +func (mr *MockKubernetesServiceIfaceMockRecorder) NewRemoveNodesFromKubernetesClusterParams(id, nodeids any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRemoveNodesFromKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewRemoveNodesFromKubernetesClusterParams), id, nodeids) +} + // NewRemoveVirtualMachinesFromKubernetesClusterParams mocks base method. func (m *MockKubernetesServiceIface) NewRemoveVirtualMachinesFromKubernetesClusterParams(id string, virtualmachineids []string) *RemoveVirtualMachinesFromKubernetesClusterParams { m.ctrl.T.Helper() @@ -500,6 +543,21 @@ func (mr *MockKubernetesServiceIfaceMockRecorder) NewUpgradeKubernetesClusterPar return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpgradeKubernetesClusterParams", reflect.TypeOf((*MockKubernetesServiceIface)(nil).NewUpgradeKubernetesClusterParams), id, kubernetesversionid) } +// RemoveNodesFromKubernetesCluster mocks base method. +func (m *MockKubernetesServiceIface) RemoveNodesFromKubernetesCluster(p *RemoveNodesFromKubernetesClusterParams) (*RemoveNodesFromKubernetesClusterResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "RemoveNodesFromKubernetesCluster", p) + ret0, _ := ret[0].(*RemoveNodesFromKubernetesClusterResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// RemoveNodesFromKubernetesCluster indicates an expected call of RemoveNodesFromKubernetesCluster. +func (mr *MockKubernetesServiceIfaceMockRecorder) RemoveNodesFromKubernetesCluster(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RemoveNodesFromKubernetesCluster", reflect.TypeOf((*MockKubernetesServiceIface)(nil).RemoveNodesFromKubernetesCluster), p) +} + // RemoveVirtualMachinesFromKubernetesCluster mocks base method. func (m *MockKubernetesServiceIface) RemoveVirtualMachinesFromKubernetesCluster(p *RemoveVirtualMachinesFromKubernetesClusterParams) (*RemoveVirtualMachinesFromKubernetesClusterResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/NetrisService.go b/cloudstack/NetrisService.go new file mode 100644 index 00000000..6e63cdc0 --- /dev/null +++ b/cloudstack/NetrisService.go @@ -0,0 +1,507 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package cloudstack + +import ( + "encoding/json" + "net/url" + "strconv" +) + +type NetrisServiceIface interface { + AddNetrisProvider(p *AddNetrisProviderParams) (*AddNetrisProviderResponse, error) + NewAddNetrisProviderParams(name string, netristag string, netrisurl string, password string, sitename string, tenantname string, username string, zoneid string) *AddNetrisProviderParams + DeleteNetrisProvider(p *DeleteNetrisProviderParams) (*DeleteNetrisProviderResponse, error) + NewDeleteNetrisProviderParams(id string) *DeleteNetrisProviderParams + ListNetrisProviders(p *ListNetrisProvidersParams) (*ListNetrisProvidersResponse, error) + NewListNetrisProvidersParams() *ListNetrisProvidersParams +} + +type AddNetrisProviderParams struct { + p map[string]interface{} +} + +func (p *AddNetrisProviderParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["netristag"]; found { + u.Set("netristag", v.(string)) + } + if v, found := p.p["netrisurl"]; found { + u.Set("netrisurl", v.(string)) + } + if v, found := p.p["password"]; found { + u.Set("password", v.(string)) + } + if v, found := p.p["sitename"]; found { + u.Set("sitename", v.(string)) + } + if v, found := p.p["tenantname"]; found { + u.Set("tenantname", v.(string)) + } + if v, found := p.p["username"]; found { + u.Set("username", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *AddNetrisProviderParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *AddNetrisProviderParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *AddNetrisProviderParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *AddNetrisProviderParams) SetNetristag(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["netristag"] = v +} + +func (p *AddNetrisProviderParams) ResetNetristag() { + if p.p != nil && p.p["netristag"] != nil { + delete(p.p, "netristag") + } +} + +func (p *AddNetrisProviderParams) GetNetristag() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["netristag"].(string) + return value, ok +} + +func (p *AddNetrisProviderParams) SetNetrisurl(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["netrisurl"] = v +} + +func (p *AddNetrisProviderParams) ResetNetrisurl() { + if p.p != nil && p.p["netrisurl"] != nil { + delete(p.p, "netrisurl") + } +} + +func (p *AddNetrisProviderParams) GetNetrisurl() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["netrisurl"].(string) + return value, ok +} + +func (p *AddNetrisProviderParams) SetPassword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["password"] = v +} + +func (p *AddNetrisProviderParams) ResetPassword() { + if p.p != nil && p.p["password"] != nil { + delete(p.p, "password") + } +} + +func (p *AddNetrisProviderParams) GetPassword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["password"].(string) + return value, ok +} + +func (p *AddNetrisProviderParams) SetSitename(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["sitename"] = v +} + +func (p *AddNetrisProviderParams) ResetSitename() { + if p.p != nil && p.p["sitename"] != nil { + delete(p.p, "sitename") + } +} + +func (p *AddNetrisProviderParams) GetSitename() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["sitename"].(string) + return value, ok +} + +func (p *AddNetrisProviderParams) SetTenantname(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tenantname"] = v +} + +func (p *AddNetrisProviderParams) ResetTenantname() { + if p.p != nil && p.p["tenantname"] != nil { + delete(p.p, "tenantname") + } +} + +func (p *AddNetrisProviderParams) GetTenantname() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tenantname"].(string) + return value, ok +} + +func (p *AddNetrisProviderParams) SetUsername(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["username"] = v +} + +func (p *AddNetrisProviderParams) ResetUsername() { + if p.p != nil && p.p["username"] != nil { + delete(p.p, "username") + } +} + +func (p *AddNetrisProviderParams) GetUsername() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["username"].(string) + return value, ok +} + +func (p *AddNetrisProviderParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *AddNetrisProviderParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *AddNetrisProviderParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new AddNetrisProviderParams instance, +// as then you are sure you have configured all required params +func (s *NetrisService) NewAddNetrisProviderParams(name string, netristag string, netrisurl string, password string, sitename string, tenantname string, username string, zoneid string) *AddNetrisProviderParams { + p := &AddNetrisProviderParams{} + p.p = make(map[string]interface{}) + p.p["name"] = name + p.p["netristag"] = netristag + p.p["netrisurl"] = netrisurl + p.p["password"] = password + p.p["sitename"] = sitename + p.p["tenantname"] = tenantname + p.p["username"] = username + p.p["zoneid"] = zoneid + return p +} + +// Add Netris Provider to CloudStack +func (s *NetrisService) AddNetrisProvider(p *AddNetrisProviderParams) (*AddNetrisProviderResponse, error) { + resp, err := s.cs.newPostRequest("addNetrisProvider", p.toURLValues()) + if err != nil { + return nil, err + } + + var r AddNetrisProviderResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type AddNetrisProviderResponse struct { + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Netristag string `json:"netristag"` + Netrisurl string `json:"netrisurl"` + Sitename string `json:"sitename"` + Tenantname string `json:"tenantname"` + Uuid string `json:"uuid"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type DeleteNetrisProviderParams struct { + p map[string]interface{} +} + +func (p *DeleteNetrisProviderParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteNetrisProviderParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteNetrisProviderParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteNetrisProviderParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteNetrisProviderParams instance, +// as then you are sure you have configured all required params +func (s *NetrisService) NewDeleteNetrisProviderParams(id string) *DeleteNetrisProviderParams { + p := &DeleteNetrisProviderParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// delete Netris Provider to CloudStack +func (s *NetrisService) DeleteNetrisProvider(p *DeleteNetrisProviderParams) (*DeleteNetrisProviderResponse, error) { + resp, err := s.cs.newPostRequest("deleteNetrisProvider", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteNetrisProviderResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteNetrisProviderResponse struct { + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Netristag string `json:"netristag"` + Netrisurl string `json:"netrisurl"` + Sitename string `json:"sitename"` + Tenantname string `json:"tenantname"` + Uuid string `json:"uuid"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type ListNetrisProvidersParams struct { + p map[string]interface{} +} + +func (p *ListNetrisProvidersParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListNetrisProvidersParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListNetrisProvidersParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListNetrisProvidersParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListNetrisProvidersParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListNetrisProvidersParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListNetrisProvidersParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListNetrisProvidersParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListNetrisProvidersParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListNetrisProvidersParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListNetrisProvidersParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListNetrisProvidersParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ListNetrisProvidersParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new ListNetrisProvidersParams instance, +// as then you are sure you have configured all required params +func (s *NetrisService) NewListNetrisProvidersParams() *ListNetrisProvidersParams { + p := &ListNetrisProvidersParams{} + p.p = make(map[string]interface{}) + return p +} + +// list all Netris providers added to CloudStack +func (s *NetrisService) ListNetrisProviders(p *ListNetrisProvidersParams) (*ListNetrisProvidersResponse, error) { + resp, err := s.cs.newRequest("listNetrisProviders", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListNetrisProvidersResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListNetrisProvidersResponse struct { + Count int `json:"count"` + NetrisProviders []*NetrisProvider `json:"netrisprovider"` +} + +type NetrisProvider struct { + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Netristag string `json:"netristag"` + Netrisurl string `json:"netrisurl"` + Sitename string `json:"sitename"` + Tenantname string `json:"tenantname"` + Uuid string `json:"uuid"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} diff --git a/cloudstack/NetrisService_mock.go b/cloudstack/NetrisService_mock.go new file mode 100644 index 00000000..2f1ea84d --- /dev/null +++ b/cloudstack/NetrisService_mock.go @@ -0,0 +1,146 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +// Code generated by MockGen. DO NOT EDIT. +// Source: ./cloudstack/NetrisService.go +// +// Generated by this command: +// +// mockgen -destination=./cloudstack/NetrisService_mock.go -package=cloudstack -copyright_file=header.txt -source=./cloudstack/NetrisService.go +// + +// Package cloudstack is a generated GoMock package. +package cloudstack + +import ( + reflect "reflect" + + gomock "go.uber.org/mock/gomock" +) + +// MockNetrisServiceIface is a mock of NetrisServiceIface interface. +type MockNetrisServiceIface struct { + ctrl *gomock.Controller + recorder *MockNetrisServiceIfaceMockRecorder + isgomock struct{} +} + +// MockNetrisServiceIfaceMockRecorder is the mock recorder for MockNetrisServiceIface. +type MockNetrisServiceIfaceMockRecorder struct { + mock *MockNetrisServiceIface +} + +// NewMockNetrisServiceIface creates a new mock instance. +func NewMockNetrisServiceIface(ctrl *gomock.Controller) *MockNetrisServiceIface { + mock := &MockNetrisServiceIface{ctrl: ctrl} + mock.recorder = &MockNetrisServiceIfaceMockRecorder{mock} + return mock +} + +// EXPECT returns an object that allows the caller to indicate expected use. +func (m *MockNetrisServiceIface) EXPECT() *MockNetrisServiceIfaceMockRecorder { + return m.recorder +} + +// AddNetrisProvider mocks base method. +func (m *MockNetrisServiceIface) AddNetrisProvider(p *AddNetrisProviderParams) (*AddNetrisProviderResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "AddNetrisProvider", p) + ret0, _ := ret[0].(*AddNetrisProviderResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// AddNetrisProvider indicates an expected call of AddNetrisProvider. +func (mr *MockNetrisServiceIfaceMockRecorder) AddNetrisProvider(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddNetrisProvider", reflect.TypeOf((*MockNetrisServiceIface)(nil).AddNetrisProvider), p) +} + +// DeleteNetrisProvider mocks base method. +func (m *MockNetrisServiceIface) DeleteNetrisProvider(p *DeleteNetrisProviderParams) (*DeleteNetrisProviderResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteNetrisProvider", p) + ret0, _ := ret[0].(*DeleteNetrisProviderResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteNetrisProvider indicates an expected call of DeleteNetrisProvider. +func (mr *MockNetrisServiceIfaceMockRecorder) DeleteNetrisProvider(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteNetrisProvider", reflect.TypeOf((*MockNetrisServiceIface)(nil).DeleteNetrisProvider), p) +} + +// ListNetrisProviders mocks base method. +func (m *MockNetrisServiceIface) ListNetrisProviders(p *ListNetrisProvidersParams) (*ListNetrisProvidersResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListNetrisProviders", p) + ret0, _ := ret[0].(*ListNetrisProvidersResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListNetrisProviders indicates an expected call of ListNetrisProviders. +func (mr *MockNetrisServiceIfaceMockRecorder) ListNetrisProviders(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListNetrisProviders", reflect.TypeOf((*MockNetrisServiceIface)(nil).ListNetrisProviders), p) +} + +// NewAddNetrisProviderParams mocks base method. +func (m *MockNetrisServiceIface) NewAddNetrisProviderParams(name, netristag, netrisurl, password, sitename, tenantname, username, zoneid string) *AddNetrisProviderParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewAddNetrisProviderParams", name, netristag, netrisurl, password, sitename, tenantname, username, zoneid) + ret0, _ := ret[0].(*AddNetrisProviderParams) + return ret0 +} + +// NewAddNetrisProviderParams indicates an expected call of NewAddNetrisProviderParams. +func (mr *MockNetrisServiceIfaceMockRecorder) NewAddNetrisProviderParams(name, netristag, netrisurl, password, sitename, tenantname, username, zoneid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAddNetrisProviderParams", reflect.TypeOf((*MockNetrisServiceIface)(nil).NewAddNetrisProviderParams), name, netristag, netrisurl, password, sitename, tenantname, username, zoneid) +} + +// NewDeleteNetrisProviderParams mocks base method. +func (m *MockNetrisServiceIface) NewDeleteNetrisProviderParams(id string) *DeleteNetrisProviderParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteNetrisProviderParams", id) + ret0, _ := ret[0].(*DeleteNetrisProviderParams) + return ret0 +} + +// NewDeleteNetrisProviderParams indicates an expected call of NewDeleteNetrisProviderParams. +func (mr *MockNetrisServiceIfaceMockRecorder) NewDeleteNetrisProviderParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteNetrisProviderParams", reflect.TypeOf((*MockNetrisServiceIface)(nil).NewDeleteNetrisProviderParams), id) +} + +// NewListNetrisProvidersParams mocks base method. +func (m *MockNetrisServiceIface) NewListNetrisProvidersParams() *ListNetrisProvidersParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListNetrisProvidersParams") + ret0, _ := ret[0].(*ListNetrisProvidersParams) + return ret0 +} + +// NewListNetrisProvidersParams indicates an expected call of NewListNetrisProvidersParams. +func (mr *MockNetrisServiceIfaceMockRecorder) NewListNetrisProvidersParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListNetrisProvidersParams", reflect.TypeOf((*MockNetrisServiceIface)(nil).NewListNetrisProvidersParams)) +} diff --git a/cloudstack/NsxService.go b/cloudstack/NsxService.go new file mode 100644 index 00000000..f87bb1c1 --- /dev/null +++ b/cloudstack/NsxService.go @@ -0,0 +1,534 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package cloudstack + +import ( + "encoding/json" + "net/url" + "strconv" +) + +type NsxServiceIface interface { + AddNsxController(p *AddNsxControllerParams) (*AddNsxControllerResponse, error) + NewAddNsxControllerParams(edgecluster string, name string, nsxproviderhostname string, password string, tier0gateway string, transportzone string, username string, zoneid string) *AddNsxControllerParams + DeleteNsxController(p *DeleteNsxControllerParams) (*DeleteNsxControllerResponse, error) + NewDeleteNsxControllerParams(nsxcontrollerid string) *DeleteNsxControllerParams + ListNsxControllers(p *ListNsxControllersParams) (*ListNsxControllersResponse, error) + NewListNsxControllersParams() *ListNsxControllersParams +} + +type AddNsxControllerParams struct { + p map[string]interface{} +} + +func (p *AddNsxControllerParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["edgecluster"]; found { + u.Set("edgecluster", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["nsxproviderhostname"]; found { + u.Set("nsxproviderhostname", v.(string)) + } + if v, found := p.p["nsxproviderport"]; found { + u.Set("nsxproviderport", v.(string)) + } + if v, found := p.p["password"]; found { + u.Set("password", v.(string)) + } + if v, found := p.p["tier0gateway"]; found { + u.Set("tier0gateway", v.(string)) + } + if v, found := p.p["transportzone"]; found { + u.Set("transportzone", v.(string)) + } + if v, found := p.p["username"]; found { + u.Set("username", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *AddNsxControllerParams) SetEdgecluster(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["edgecluster"] = v +} + +func (p *AddNsxControllerParams) ResetEdgecluster() { + if p.p != nil && p.p["edgecluster"] != nil { + delete(p.p, "edgecluster") + } +} + +func (p *AddNsxControllerParams) GetEdgecluster() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["edgecluster"].(string) + return value, ok +} + +func (p *AddNsxControllerParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *AddNsxControllerParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *AddNsxControllerParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *AddNsxControllerParams) SetNsxproviderhostname(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nsxproviderhostname"] = v +} + +func (p *AddNsxControllerParams) ResetNsxproviderhostname() { + if p.p != nil && p.p["nsxproviderhostname"] != nil { + delete(p.p, "nsxproviderhostname") + } +} + +func (p *AddNsxControllerParams) GetNsxproviderhostname() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nsxproviderhostname"].(string) + return value, ok +} + +func (p *AddNsxControllerParams) SetNsxproviderport(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nsxproviderport"] = v +} + +func (p *AddNsxControllerParams) ResetNsxproviderport() { + if p.p != nil && p.p["nsxproviderport"] != nil { + delete(p.p, "nsxproviderport") + } +} + +func (p *AddNsxControllerParams) GetNsxproviderport() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nsxproviderport"].(string) + return value, ok +} + +func (p *AddNsxControllerParams) SetPassword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["password"] = v +} + +func (p *AddNsxControllerParams) ResetPassword() { + if p.p != nil && p.p["password"] != nil { + delete(p.p, "password") + } +} + +func (p *AddNsxControllerParams) GetPassword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["password"].(string) + return value, ok +} + +func (p *AddNsxControllerParams) SetTier0gateway(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tier0gateway"] = v +} + +func (p *AddNsxControllerParams) ResetTier0gateway() { + if p.p != nil && p.p["tier0gateway"] != nil { + delete(p.p, "tier0gateway") + } +} + +func (p *AddNsxControllerParams) GetTier0gateway() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tier0gateway"].(string) + return value, ok +} + +func (p *AddNsxControllerParams) SetTransportzone(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["transportzone"] = v +} + +func (p *AddNsxControllerParams) ResetTransportzone() { + if p.p != nil && p.p["transportzone"] != nil { + delete(p.p, "transportzone") + } +} + +func (p *AddNsxControllerParams) GetTransportzone() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["transportzone"].(string) + return value, ok +} + +func (p *AddNsxControllerParams) SetUsername(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["username"] = v +} + +func (p *AddNsxControllerParams) ResetUsername() { + if p.p != nil && p.p["username"] != nil { + delete(p.p, "username") + } +} + +func (p *AddNsxControllerParams) GetUsername() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["username"].(string) + return value, ok +} + +func (p *AddNsxControllerParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *AddNsxControllerParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *AddNsxControllerParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new AddNsxControllerParams instance, +// as then you are sure you have configured all required params +func (s *NsxService) NewAddNsxControllerParams(edgecluster string, name string, nsxproviderhostname string, password string, tier0gateway string, transportzone string, username string, zoneid string) *AddNsxControllerParams { + p := &AddNsxControllerParams{} + p.p = make(map[string]interface{}) + p.p["edgecluster"] = edgecluster + p.p["name"] = name + p.p["nsxproviderhostname"] = nsxproviderhostname + p.p["password"] = password + p.p["tier0gateway"] = tier0gateway + p.p["transportzone"] = transportzone + p.p["username"] = username + p.p["zoneid"] = zoneid + return p +} + +// Add NSX Controller to CloudStack +func (s *NsxService) AddNsxController(p *AddNsxControllerParams) (*AddNsxControllerResponse, error) { + resp, err := s.cs.newPostRequest("addNsxController", p.toURLValues()) + if err != nil { + return nil, err + } + + var r AddNsxControllerResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type AddNsxControllerResponse struct { + Edgecluster string `json:"edgecluster"` + Hostname string `json:"hostname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Nsxprovideruuid string `json:"nsxprovideruuid"` + Port string `json:"port"` + Tier0gateway string `json:"tier0gateway"` + Transportzone string `json:"transportzone"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type DeleteNsxControllerParams struct { + p map[string]interface{} +} + +func (p *DeleteNsxControllerParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["nsxcontrollerid"]; found { + u.Set("nsxcontrollerid", v.(string)) + } + return u +} + +func (p *DeleteNsxControllerParams) SetNsxcontrollerid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nsxcontrollerid"] = v +} + +func (p *DeleteNsxControllerParams) ResetNsxcontrollerid() { + if p.p != nil && p.p["nsxcontrollerid"] != nil { + delete(p.p, "nsxcontrollerid") + } +} + +func (p *DeleteNsxControllerParams) GetNsxcontrollerid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nsxcontrollerid"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteNsxControllerParams instance, +// as then you are sure you have configured all required params +func (s *NsxService) NewDeleteNsxControllerParams(nsxcontrollerid string) *DeleteNsxControllerParams { + p := &DeleteNsxControllerParams{} + p.p = make(map[string]interface{}) + p.p["nsxcontrollerid"] = nsxcontrollerid + return p +} + +// delete NSX Controller to CloudStack +func (s *NsxService) DeleteNsxController(p *DeleteNsxControllerParams) (*DeleteNsxControllerResponse, error) { + resp, err := s.cs.newPostRequest("deleteNsxController", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteNsxControllerResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteNsxControllerResponse struct { + Edgecluster string `json:"edgecluster"` + Hostname string `json:"hostname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Nsxprovideruuid string `json:"nsxprovideruuid"` + Port string `json:"port"` + Tier0gateway string `json:"tier0gateway"` + Transportzone string `json:"transportzone"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type ListNsxControllersParams struct { + p map[string]interface{} +} + +func (p *ListNsxControllersParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListNsxControllersParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListNsxControllersParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListNsxControllersParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListNsxControllersParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListNsxControllersParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListNsxControllersParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListNsxControllersParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListNsxControllersParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListNsxControllersParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListNsxControllersParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListNsxControllersParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ListNsxControllersParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new ListNsxControllersParams instance, +// as then you are sure you have configured all required params +func (s *NsxService) NewListNsxControllersParams() *ListNsxControllersParams { + p := &ListNsxControllersParams{} + p.p = make(map[string]interface{}) + return p +} + +// list all NSX controllers added to CloudStack +func (s *NsxService) ListNsxControllers(p *ListNsxControllersParams) (*ListNsxControllersResponse, error) { + resp, err := s.cs.newRequest("listNsxControllers", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListNsxControllersResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListNsxControllersResponse struct { + Count int `json:"count"` + NsxControllers []*NsxController `json:"nsxcontroller"` +} + +type NsxController struct { + Edgecluster string `json:"edgecluster"` + Hostname string `json:"hostname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Nsxprovideruuid string `json:"nsxprovideruuid"` + Port string `json:"port"` + Tier0gateway string `json:"tier0gateway"` + Transportzone string `json:"transportzone"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} diff --git a/cloudstack/NsxService_mock.go b/cloudstack/NsxService_mock.go new file mode 100644 index 00000000..34e27df8 --- /dev/null +++ b/cloudstack/NsxService_mock.go @@ -0,0 +1,146 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +// Code generated by MockGen. DO NOT EDIT. +// Source: ./cloudstack/NsxService.go +// +// Generated by this command: +// +// mockgen -destination=./cloudstack/NsxService_mock.go -package=cloudstack -copyright_file=header.txt -source=./cloudstack/NsxService.go +// + +// Package cloudstack is a generated GoMock package. +package cloudstack + +import ( + reflect "reflect" + + gomock "go.uber.org/mock/gomock" +) + +// MockNsxServiceIface is a mock of NsxServiceIface interface. +type MockNsxServiceIface struct { + ctrl *gomock.Controller + recorder *MockNsxServiceIfaceMockRecorder + isgomock struct{} +} + +// MockNsxServiceIfaceMockRecorder is the mock recorder for MockNsxServiceIface. +type MockNsxServiceIfaceMockRecorder struct { + mock *MockNsxServiceIface +} + +// NewMockNsxServiceIface creates a new mock instance. +func NewMockNsxServiceIface(ctrl *gomock.Controller) *MockNsxServiceIface { + mock := &MockNsxServiceIface{ctrl: ctrl} + mock.recorder = &MockNsxServiceIfaceMockRecorder{mock} + return mock +} + +// EXPECT returns an object that allows the caller to indicate expected use. +func (m *MockNsxServiceIface) EXPECT() *MockNsxServiceIfaceMockRecorder { + return m.recorder +} + +// AddNsxController mocks base method. +func (m *MockNsxServiceIface) AddNsxController(p *AddNsxControllerParams) (*AddNsxControllerResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "AddNsxController", p) + ret0, _ := ret[0].(*AddNsxControllerResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// AddNsxController indicates an expected call of AddNsxController. +func (mr *MockNsxServiceIfaceMockRecorder) AddNsxController(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddNsxController", reflect.TypeOf((*MockNsxServiceIface)(nil).AddNsxController), p) +} + +// DeleteNsxController mocks base method. +func (m *MockNsxServiceIface) DeleteNsxController(p *DeleteNsxControllerParams) (*DeleteNsxControllerResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteNsxController", p) + ret0, _ := ret[0].(*DeleteNsxControllerResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteNsxController indicates an expected call of DeleteNsxController. +func (mr *MockNsxServiceIfaceMockRecorder) DeleteNsxController(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteNsxController", reflect.TypeOf((*MockNsxServiceIface)(nil).DeleteNsxController), p) +} + +// ListNsxControllers mocks base method. +func (m *MockNsxServiceIface) ListNsxControllers(p *ListNsxControllersParams) (*ListNsxControllersResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListNsxControllers", p) + ret0, _ := ret[0].(*ListNsxControllersResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListNsxControllers indicates an expected call of ListNsxControllers. +func (mr *MockNsxServiceIfaceMockRecorder) ListNsxControllers(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListNsxControllers", reflect.TypeOf((*MockNsxServiceIface)(nil).ListNsxControllers), p) +} + +// NewAddNsxControllerParams mocks base method. +func (m *MockNsxServiceIface) NewAddNsxControllerParams(edgecluster, name, nsxproviderhostname, password, tier0gateway, transportzone, username, zoneid string) *AddNsxControllerParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewAddNsxControllerParams", edgecluster, name, nsxproviderhostname, password, tier0gateway, transportzone, username, zoneid) + ret0, _ := ret[0].(*AddNsxControllerParams) + return ret0 +} + +// NewAddNsxControllerParams indicates an expected call of NewAddNsxControllerParams. +func (mr *MockNsxServiceIfaceMockRecorder) NewAddNsxControllerParams(edgecluster, name, nsxproviderhostname, password, tier0gateway, transportzone, username, zoneid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAddNsxControllerParams", reflect.TypeOf((*MockNsxServiceIface)(nil).NewAddNsxControllerParams), edgecluster, name, nsxproviderhostname, password, tier0gateway, transportzone, username, zoneid) +} + +// NewDeleteNsxControllerParams mocks base method. +func (m *MockNsxServiceIface) NewDeleteNsxControllerParams(nsxcontrollerid string) *DeleteNsxControllerParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteNsxControllerParams", nsxcontrollerid) + ret0, _ := ret[0].(*DeleteNsxControllerParams) + return ret0 +} + +// NewDeleteNsxControllerParams indicates an expected call of NewDeleteNsxControllerParams. +func (mr *MockNsxServiceIfaceMockRecorder) NewDeleteNsxControllerParams(nsxcontrollerid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteNsxControllerParams", reflect.TypeOf((*MockNsxServiceIface)(nil).NewDeleteNsxControllerParams), nsxcontrollerid) +} + +// NewListNsxControllersParams mocks base method. +func (m *MockNsxServiceIface) NewListNsxControllersParams() *ListNsxControllersParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListNsxControllersParams") + ret0, _ := ret[0].(*ListNsxControllersParams) + return ret0 +} + +// NewListNsxControllersParams indicates an expected call of NewListNsxControllersParams. +func (mr *MockNsxServiceIfaceMockRecorder) NewListNsxControllersParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListNsxControllersParams", reflect.TypeOf((*MockNsxServiceIface)(nil).NewListNsxControllersParams)) +} diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index d7d0d4ce..4d531db6 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -143,6 +143,7 @@ type CloudStackClient struct { Metrics MetricsServiceIface Misc MiscServiceIface NAT NATServiceIface + Netris NetrisServiceIface Netscaler NetscalerServiceIface NetworkACL NetworkACLServiceIface NetworkDevice NetworkDeviceServiceIface @@ -150,6 +151,7 @@ type CloudStackClient struct { Network NetworkServiceIface Nic NicServiceIface NiciraNVP NiciraNVPServiceIface + Nsx NsxServiceIface Oauth OauthServiceIface ObjectStore ObjectStoreServiceIface OutofbandManagement OutofbandManagementServiceIface @@ -271,6 +273,7 @@ func newClient(apiurl string, apikey string, secret string, async bool, verifyss cs.Metrics = NewMetricsService(cs) cs.Misc = NewMiscService(cs) cs.NAT = NewNATService(cs) + cs.Netris = NewNetrisService(cs) cs.Netscaler = NewNetscalerService(cs) cs.NetworkACL = NewNetworkACLService(cs) cs.NetworkDevice = NewNetworkDeviceService(cs) @@ -278,6 +281,7 @@ func newClient(apiurl string, apikey string, secret string, async bool, verifyss cs.Network = NewNetworkService(cs) cs.Nic = NewNicService(cs) cs.NiciraNVP = NewNiciraNVPService(cs) + cs.Nsx = NewNsxService(cs) cs.Oauth = NewOauthService(cs) cs.ObjectStore = NewObjectStoreService(cs) cs.OutofbandManagement = NewOutofbandManagementService(cs) @@ -372,6 +376,7 @@ func newMockClient(ctrl *gomock.Controller) *CloudStackClient { cs.Metrics = NewMockMetricsServiceIface(ctrl) cs.Misc = NewMockMiscServiceIface(ctrl) cs.NAT = NewMockNATServiceIface(ctrl) + cs.Netris = NewMockNetrisServiceIface(ctrl) cs.Netscaler = NewMockNetscalerServiceIface(ctrl) cs.NetworkACL = NewMockNetworkACLServiceIface(ctrl) cs.NetworkDevice = NewMockNetworkDeviceServiceIface(ctrl) @@ -379,6 +384,7 @@ func newMockClient(ctrl *gomock.Controller) *CloudStackClient { cs.Network = NewMockNetworkServiceIface(ctrl) cs.Nic = NewMockNicServiceIface(ctrl) cs.NiciraNVP = NewMockNiciraNVPServiceIface(ctrl) + cs.Nsx = NewMockNsxServiceIface(ctrl) cs.Oauth = NewMockOauthServiceIface(ctrl) cs.ObjectStore = NewMockObjectStoreServiceIface(ctrl) cs.OutofbandManagement = NewMockOutofbandManagementServiceIface(ctrl) @@ -1159,6 +1165,14 @@ func NewNATService(cs *CloudStackClient) NATServiceIface { return &NATService{cs: cs} } +type NetrisService struct { + cs *CloudStackClient +} + +func NewNetrisService(cs *CloudStackClient) NetrisServiceIface { + return &NetrisService{cs: cs} +} + type NetscalerService struct { cs *CloudStackClient } @@ -1215,6 +1229,14 @@ func NewNiciraNVPService(cs *CloudStackClient) NiciraNVPServiceIface { return &NiciraNVPService{cs: cs} } +type NsxService struct { + cs *CloudStackClient +} + +func NewNsxService(cs *CloudStackClient) NsxServiceIface { + return &NsxService{cs: cs} +} + type OauthService struct { cs *CloudStackClient } diff --git a/generate/layout.go b/generate/layout.go index 35da4107..40a6d136 100644 --- a/generate/layout.go +++ b/generate/layout.go @@ -744,6 +744,9 @@ var layout = apiInfo{ "updateConfiguration", "resetConfiguration", "updateStorageCapabilities", + "registerCniConfiguration", + "listCniConfiguration", + "deleteCniConfiguration", }, "BrocadeVCSService": { "addBrocadeVcsDevice", @@ -869,6 +872,8 @@ var layout = apiInfo{ "upgradeKubernetesCluster", "addVirtualMachinesToKubernetesCluster", "removeVirtualMachinesFromKubernetesCluster", + "addNodesToKubernetesCluster", + "removeNodesFromKubernetesCluster", }, "InfrastructureUsageService": { "listDbMetrics", @@ -920,6 +925,11 @@ var layout = apiInfo{ "MiscService": { "listElastistorInterface", }, + "NetrisService": { + "addNetrisProvider", + "deleteNetrisProvider", + "listNetrisProviders", + }, "NetscalerService": { "addNetscalerLoadBalancer", "configureNetscalerLoadBalancer", @@ -931,6 +941,11 @@ var layout = apiInfo{ "registerNetscalerControlCenter", "registerNetscalerServicePackage", }, + "NsxService": { + "addNsxController", + "deleteNsxController", + "listNsxControllers", + }, "ResourceIconService": { "deleteResourceIcon", "listResourceIcon", diff --git a/test/ConfigurationService_test.go b/test/ConfigurationService_test.go index a0a72d81..623232d6 100644 --- a/test/ConfigurationService_test.go +++ b/test/ConfigurationService_test.go @@ -122,4 +122,40 @@ func TestConfigurationService(t *testing.T) { } t.Run("UpdateStorageCapabilities", testupdateStorageCapabilities) + testregisterCniConfiguration := func(t *testing.T) { + if _, ok := response["registerCniConfiguration"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Configuration.NewRegisterCniConfigurationParams("name") + _, err := client.Configuration.RegisterCniConfiguration(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("RegisterCniConfiguration", testregisterCniConfiguration) + + testlistCniConfiguration := func(t *testing.T) { + if _, ok := response["listCniConfiguration"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Configuration.NewListCniConfigurationParams() + _, err := client.Configuration.ListCniConfiguration(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListCniConfiguration", testlistCniConfiguration) + + testdeleteCniConfiguration := func(t *testing.T) { + if _, ok := response["deleteCniConfiguration"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Configuration.NewDeleteCniConfigurationParams("id") + _, err := client.Configuration.DeleteCniConfiguration(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteCniConfiguration", testdeleteCniConfiguration) + } diff --git a/test/KubernetesService_test.go b/test/KubernetesService_test.go index 81e09932..e7c02767 100644 --- a/test/KubernetesService_test.go +++ b/test/KubernetesService_test.go @@ -227,4 +227,34 @@ func TestKubernetesService(t *testing.T) { } t.Run("RemoveVirtualMachinesFromKubernetesCluster", testremoveVirtualMachinesFromKubernetesCluster) + testaddNodesToKubernetesCluster := func(t *testing.T) { + if _, ok := response["addNodesToKubernetesCluster"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Kubernetes.NewAddNodesToKubernetesClusterParams("id", []string{}) + r, err := client.Kubernetes.AddNodesToKubernetesCluster(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("AddNodesToKubernetesCluster", testaddNodesToKubernetesCluster) + + testremoveNodesFromKubernetesCluster := func(t *testing.T) { + if _, ok := response["removeNodesFromKubernetesCluster"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Kubernetes.NewRemoveNodesFromKubernetesClusterParams("id", []string{}) + r, err := client.Kubernetes.RemoveNodesFromKubernetesCluster(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("RemoveNodesFromKubernetesCluster", testremoveNodesFromKubernetesCluster) + } diff --git a/test/NetrisService_test.go b/test/NetrisService_test.go new file mode 100644 index 00000000..6780d047 --- /dev/null +++ b/test/NetrisService_test.go @@ -0,0 +1,74 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package test + +import ( + "testing" + + "github.com/apache/cloudstack-go/v2/cloudstack" +) + +func TestNetrisService(t *testing.T) { + service := "NetrisService" + response, err := readData(service) + if err != nil { + t.Skipf("Skipping test as %v", err) + } + server := CreateTestServer(t, response) + client := cloudstack.NewClient(server.URL, "APIKEY", "SECRETKEY", true) + defer server.Close() + + testaddNetrisProvider := func(t *testing.T) { + if _, ok := response["addNetrisProvider"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Netris.NewAddNetrisProviderParams("name", "netristag", "netrisurl", "password", "sitename", "tenantname", "username", "zoneid") + _, err := client.Netris.AddNetrisProvider(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("AddNetrisProvider", testaddNetrisProvider) + + testdeleteNetrisProvider := func(t *testing.T) { + if _, ok := response["deleteNetrisProvider"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Netris.NewDeleteNetrisProviderParams("id") + _, err := client.Netris.DeleteNetrisProvider(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteNetrisProvider", testdeleteNetrisProvider) + + testlistNetrisProviders := func(t *testing.T) { + if _, ok := response["listNetrisProviders"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Netris.NewListNetrisProvidersParams() + _, err := client.Netris.ListNetrisProviders(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListNetrisProviders", testlistNetrisProviders) + +} diff --git a/test/NsxService_test.go b/test/NsxService_test.go new file mode 100644 index 00000000..d690fa68 --- /dev/null +++ b/test/NsxService_test.go @@ -0,0 +1,74 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package test + +import ( + "testing" + + "github.com/apache/cloudstack-go/v2/cloudstack" +) + +func TestNsxService(t *testing.T) { + service := "NsxService" + response, err := readData(service) + if err != nil { + t.Skipf("Skipping test as %v", err) + } + server := CreateTestServer(t, response) + client := cloudstack.NewClient(server.URL, "APIKEY", "SECRETKEY", true) + defer server.Close() + + testaddNsxController := func(t *testing.T) { + if _, ok := response["addNsxController"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Nsx.NewAddNsxControllerParams("edgecluster", "name", "nsxproviderhostname", "password", "tier0gateway", "transportzone", "username", "zoneid") + _, err := client.Nsx.AddNsxController(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("AddNsxController", testaddNsxController) + + testdeleteNsxController := func(t *testing.T) { + if _, ok := response["deleteNsxController"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Nsx.NewDeleteNsxControllerParams("nsxcontrollerid") + _, err := client.Nsx.DeleteNsxController(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteNsxController", testdeleteNsxController) + + testlistNsxControllers := func(t *testing.T) { + if _, ok := response["listNsxControllers"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Nsx.NewListNsxControllersParams() + _, err := client.Nsx.ListNsxControllers(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListNsxControllers", testlistNsxControllers) + +} From c1e1874f09bd2f8745fa3653f4083135ac74eaea Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Tue, 23 Sep 2025 08:45:07 -0400 Subject: [PATCH 5/6] Add support for extension APIs (#124) --- cloudstack/ExtensionService.go | 2540 +++++++++++++++++++++++++++ cloudstack/ExtensionService_mock.go | 504 ++++++ cloudstack/cloudstack.go | 11 + generate/layout.go | 13 + test/ExtensionService_test.go | 191 ++ 5 files changed, 3259 insertions(+) create mode 100644 cloudstack/ExtensionService.go create mode 100644 cloudstack/ExtensionService_mock.go create mode 100644 test/ExtensionService_test.go diff --git a/cloudstack/ExtensionService.go b/cloudstack/ExtensionService.go new file mode 100644 index 00000000..b565f4a0 --- /dev/null +++ b/cloudstack/ExtensionService.go @@ -0,0 +1,2540 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package cloudstack + +import ( + "encoding/json" + "fmt" + "net/url" + "strconv" + "strings" +) + +type ExtensionServiceIface interface { + AddCustomAction(p *AddCustomActionParams) (*AddCustomActionResponse, error) + NewAddCustomActionParams(extensionid string, name string) *AddCustomActionParams + CreateExtension(p *CreateExtensionParams) (*CreateExtensionResponse, error) + NewCreateExtensionParams(name string, extensionType string) *CreateExtensionParams + DeleteCustomAction(p *DeleteCustomActionParams) (*DeleteCustomActionResponse, error) + NewDeleteCustomActionParams() *DeleteCustomActionParams + DeleteExtension(p *DeleteExtensionParams) (*DeleteExtensionResponse, error) + NewDeleteExtensionParams() *DeleteExtensionParams + ListCustomActions(p *ListCustomActionsParams) (*ListCustomActionsResponse, error) + NewListCustomActionsParams() *ListCustomActionsParams + GetCustomActionID(name string, opts ...OptionFunc) (string, int, error) + GetCustomActionByName(name string, opts ...OptionFunc) (*CustomAction, int, error) + GetCustomActionByID(id string, opts ...OptionFunc) (*CustomAction, int, error) + ListExtensions(p *ListExtensionsParams) (*ListExtensionsResponse, error) + NewListExtensionsParams() *ListExtensionsParams + GetExtensionID(name string, opts ...OptionFunc) (string, int, error) + GetExtensionByName(name string, opts ...OptionFunc) (*Extension, int, error) + GetExtensionByID(id string, opts ...OptionFunc) (*Extension, int, error) + RegisterExtension(p *RegisterExtensionParams) (*RegisterExtensionResponse, error) + NewRegisterExtensionParams(extensionid string, resourceid string, resourcetype string) *RegisterExtensionParams + RunCustomAction(p *RunCustomActionParams) (*RunCustomActionResponse, error) + NewRunCustomActionParams(customactionid string, resourceid string) *RunCustomActionParams + UnregisterExtension(p *UnregisterExtensionParams) (*UnregisterExtensionResponse, error) + NewUnregisterExtensionParams(extensionid string, resourceid string, resourcetype string) *UnregisterExtensionParams + UpdateCustomAction(p *UpdateCustomActionParams) (*UpdateCustomActionResponse, error) + NewUpdateCustomActionParams(id string) *UpdateCustomActionParams + UpdateExtension(p *UpdateExtensionParams) (*UpdateExtensionResponse, error) + NewUpdateExtensionParams(id string) *UpdateExtensionParams +} + +type AddCustomActionParams struct { + p map[string]interface{} +} + +func (p *AddCustomActionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["allowedroletypes"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("allowedroletypes", vv) + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } + if v, found := p.p["enabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("enabled", vv) + } + if v, found := p.p["errormessage"]; found { + u.Set("errormessage", v.(string)) + } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["parameters"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("parameters[%d].key", i), k) + u.Set(fmt.Sprintf("parameters[%d].value", i), m[k]) + } + } + if v, found := p.p["resourcetype"]; found { + u.Set("resourcetype", v.(string)) + } + if v, found := p.p["successmessage"]; found { + u.Set("successmessage", v.(string)) + } + if v, found := p.p["timeout"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("timeout", vv) + } + return u +} + +func (p *AddCustomActionParams) SetAllowedroletypes(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["allowedroletypes"] = v +} + +func (p *AddCustomActionParams) ResetAllowedroletypes() { + if p.p != nil && p.p["allowedroletypes"] != nil { + delete(p.p, "allowedroletypes") + } +} + +func (p *AddCustomActionParams) GetAllowedroletypes() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["allowedroletypes"].([]string) + return value, ok +} + +func (p *AddCustomActionParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *AddCustomActionParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *AddCustomActionParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *AddCustomActionParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *AddCustomActionParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *AddCustomActionParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + +func (p *AddCustomActionParams) SetEnabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enabled"] = v +} + +func (p *AddCustomActionParams) ResetEnabled() { + if p.p != nil && p.p["enabled"] != nil { + delete(p.p, "enabled") + } +} + +func (p *AddCustomActionParams) GetEnabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enabled"].(bool) + return value, ok +} + +func (p *AddCustomActionParams) SetErrormessage(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["errormessage"] = v +} + +func (p *AddCustomActionParams) ResetErrormessage() { + if p.p != nil && p.p["errormessage"] != nil { + delete(p.p, "errormessage") + } +} + +func (p *AddCustomActionParams) GetErrormessage() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["errormessage"].(string) + return value, ok +} + +func (p *AddCustomActionParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *AddCustomActionParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *AddCustomActionParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *AddCustomActionParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *AddCustomActionParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *AddCustomActionParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *AddCustomActionParams) SetParameters(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["parameters"] = v +} + +func (p *AddCustomActionParams) ResetParameters() { + if p.p != nil && p.p["parameters"] != nil { + delete(p.p, "parameters") + } +} + +func (p *AddCustomActionParams) GetParameters() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["parameters"].(map[string]string) + return value, ok +} + +func (p *AddCustomActionParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *AddCustomActionParams) ResetResourcetype() { + if p.p != nil && p.p["resourcetype"] != nil { + delete(p.p, "resourcetype") + } +} + +func (p *AddCustomActionParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + +func (p *AddCustomActionParams) SetSuccessmessage(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["successmessage"] = v +} + +func (p *AddCustomActionParams) ResetSuccessmessage() { + if p.p != nil && p.p["successmessage"] != nil { + delete(p.p, "successmessage") + } +} + +func (p *AddCustomActionParams) GetSuccessmessage() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["successmessage"].(string) + return value, ok +} + +func (p *AddCustomActionParams) SetTimeout(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["timeout"] = v +} + +func (p *AddCustomActionParams) ResetTimeout() { + if p.p != nil && p.p["timeout"] != nil { + delete(p.p, "timeout") + } +} + +func (p *AddCustomActionParams) GetTimeout() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["timeout"].(int) + return value, ok +} + +// You should always use this function to get a new AddCustomActionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewAddCustomActionParams(extensionid string, name string) *AddCustomActionParams { + p := &AddCustomActionParams{} + p.p = make(map[string]interface{}) + p.p["extensionid"] = extensionid + p.p["name"] = name + return p +} + +// Add a custom action for an extension +func (s *ExtensionService) AddCustomAction(p *AddCustomActionParams) (*AddCustomActionResponse, error) { + resp, err := s.cs.newPostRequest("addCustomAction", p.toURLValues()) + if err != nil { + return nil, err + } + + var r AddCustomActionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type AddCustomActionResponse struct { + Allowedroletypes []string `json:"allowedroletypes"` + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Enabled bool `json:"enabled"` + Errormessage string `json:"errormessage"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Parameters []AddCustomActionResponseParameters `json:"parameters"` + Resourcetype string `json:"resourcetype"` + Successmessage string `json:"successmessage"` + Timeout int `json:"timeout"` +} + +type AddCustomActionResponseParameters struct { + Name string `json:"name"` + Required bool `json:"required"` + Type string `json:"type"` + Validationformat string `json:"validationformat"` + Valueoptions []string `json:"valueoptions"` +} + +type CreateExtensionParams struct { + p map[string]interface{} +} + +func (p *CreateExtensionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["orchestratorrequirespreparevm"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("orchestratorrequirespreparevm", vv) + } + if v, found := p.p["path"]; found { + u.Set("path", v.(string)) + } + if v, found := p.p["state"]; found { + u.Set("state", v.(string)) + } + if v, found := p.p["type"]; found { + u.Set("type", v.(string)) + } + return u +} + +func (p *CreateExtensionParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *CreateExtensionParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *CreateExtensionParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *CreateExtensionParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *CreateExtensionParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *CreateExtensionParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + +func (p *CreateExtensionParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *CreateExtensionParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *CreateExtensionParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *CreateExtensionParams) SetOrchestratorrequirespreparevm(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["orchestratorrequirespreparevm"] = v +} + +func (p *CreateExtensionParams) ResetOrchestratorrequirespreparevm() { + if p.p != nil && p.p["orchestratorrequirespreparevm"] != nil { + delete(p.p, "orchestratorrequirespreparevm") + } +} + +func (p *CreateExtensionParams) GetOrchestratorrequirespreparevm() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["orchestratorrequirespreparevm"].(bool) + return value, ok +} + +func (p *CreateExtensionParams) SetPath(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["path"] = v +} + +func (p *CreateExtensionParams) ResetPath() { + if p.p != nil && p.p["path"] != nil { + delete(p.p, "path") + } +} + +func (p *CreateExtensionParams) GetPath() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["path"].(string) + return value, ok +} + +func (p *CreateExtensionParams) SetState(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["state"] = v +} + +func (p *CreateExtensionParams) ResetState() { + if p.p != nil && p.p["state"] != nil { + delete(p.p, "state") + } +} + +func (p *CreateExtensionParams) GetState() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["state"].(string) + return value, ok +} + +func (p *CreateExtensionParams) SetType(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["type"] = v +} + +func (p *CreateExtensionParams) ResetType() { + if p.p != nil && p.p["type"] != nil { + delete(p.p, "type") + } +} + +func (p *CreateExtensionParams) GetType() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["type"].(string) + return value, ok +} + +// You should always use this function to get a new CreateExtensionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewCreateExtensionParams(name string, extensionType string) *CreateExtensionParams { + p := &CreateExtensionParams{} + p.p = make(map[string]interface{}) + p.p["name"] = name + p.p["type"] = extensionType + return p +} + +// Create an extension +func (s *ExtensionService) CreateExtension(p *CreateExtensionParams) (*CreateExtensionResponse, error) { + resp, err := s.cs.newPostRequest("createExtension", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateExtensionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type CreateExtensionResponse struct { + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Resources []CreateExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` +} + +type CreateExtensionResponseResources struct { + Created string `json:"created"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Name string `json:"name"` + Type string `json:"type"` +} + +type DeleteCustomActionParams struct { + p map[string]interface{} +} + +func (p *DeleteCustomActionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteCustomActionParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteCustomActionParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteCustomActionParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteCustomActionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewDeleteCustomActionParams() *DeleteCustomActionParams { + p := &DeleteCustomActionParams{} + p.p = make(map[string]interface{}) + return p +} + +// Delete the custom action +func (s *ExtensionService) DeleteCustomAction(p *DeleteCustomActionParams) (*DeleteCustomActionResponse, error) { + resp, err := s.cs.newPostRequest("deleteCustomAction", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteCustomActionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteCustomActionResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *DeleteCustomActionResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias DeleteCustomActionResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type DeleteExtensionParams struct { + p map[string]interface{} +} + +func (p *DeleteExtensionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["cleanup"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("cleanup", vv) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteExtensionParams) SetCleanup(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cleanup"] = v +} + +func (p *DeleteExtensionParams) ResetCleanup() { + if p.p != nil && p.p["cleanup"] != nil { + delete(p.p, "cleanup") + } +} + +func (p *DeleteExtensionParams) GetCleanup() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cleanup"].(bool) + return value, ok +} + +func (p *DeleteExtensionParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteExtensionParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteExtensionParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteExtensionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewDeleteExtensionParams() *DeleteExtensionParams { + p := &DeleteExtensionParams{} + p.p = make(map[string]interface{}) + return p +} + +// Delete the extensions +func (s *ExtensionService) DeleteExtension(p *DeleteExtensionParams) (*DeleteExtensionResponse, error) { + resp, err := s.cs.newPostRequest("deleteExtension", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteExtensionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteExtensionResponse struct { + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Resources []DeleteExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` +} + +type DeleteExtensionResponseResources struct { + Created string `json:"created"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Name string `json:"name"` + Type string `json:"type"` +} + +type ListCustomActionsParams struct { + p map[string]interface{} +} + +func (p *ListCustomActionsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["enabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("enabled", vv) + } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["resourceid"]; found { + u.Set("resourceid", v.(string)) + } + if v, found := p.p["resourcetype"]; found { + u.Set("resourcetype", v.(string)) + } + return u +} + +func (p *ListCustomActionsParams) SetEnabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enabled"] = v +} + +func (p *ListCustomActionsParams) ResetEnabled() { + if p.p != nil && p.p["enabled"] != nil { + delete(p.p, "enabled") + } +} + +func (p *ListCustomActionsParams) GetEnabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enabled"].(bool) + return value, ok +} + +func (p *ListCustomActionsParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *ListCustomActionsParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *ListCustomActionsParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *ListCustomActionsParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListCustomActionsParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListCustomActionsParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListCustomActionsParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListCustomActionsParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListCustomActionsParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListCustomActionsParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListCustomActionsParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ListCustomActionsParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ListCustomActionsParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListCustomActionsParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListCustomActionsParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListCustomActionsParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListCustomActionsParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListCustomActionsParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListCustomActionsParams) SetResourceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourceid"] = v +} + +func (p *ListCustomActionsParams) ResetResourceid() { + if p.p != nil && p.p["resourceid"] != nil { + delete(p.p, "resourceid") + } +} + +func (p *ListCustomActionsParams) GetResourceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourceid"].(string) + return value, ok +} + +func (p *ListCustomActionsParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *ListCustomActionsParams) ResetResourcetype() { + if p.p != nil && p.p["resourcetype"] != nil { + delete(p.p, "resourcetype") + } +} + +func (p *ListCustomActionsParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + +// You should always use this function to get a new ListCustomActionsParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewListCustomActionsParams() *ListCustomActionsParams { + p := &ListCustomActionsParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ExtensionService) GetCustomActionID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListCustomActionsParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListCustomActions(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.CustomActions[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.CustomActions { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ExtensionService) GetCustomActionByName(name string, opts ...OptionFunc) (*CustomAction, int, error) { + id, count, err := s.GetCustomActionID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetCustomActionByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ExtensionService) GetCustomActionByID(id string, opts ...OptionFunc) (*CustomAction, int, error) { + p := &ListCustomActionsParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListCustomActions(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.CustomActions[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for CustomAction UUID: %s!", id) +} + +// Lists the custom actions +func (s *ExtensionService) ListCustomActions(p *ListCustomActionsParams) (*ListCustomActionsResponse, error) { + resp, err := s.cs.newRequest("listCustomActions", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListCustomActionsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListCustomActionsResponse struct { + Count int `json:"count"` + CustomActions []*CustomAction `json:"customaction"` +} + +type CustomAction struct { + Allowedroletypes []string `json:"allowedroletypes"` + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Enabled bool `json:"enabled"` + Errormessage string `json:"errormessage"` + Extensionid string `json:"extensionid"` + Extensionname string `json:"extensionname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Parameters []CustomActionParameters `json:"parameters"` + Resourcetype string `json:"resourcetype"` + Successmessage string `json:"successmessage"` + Timeout int `json:"timeout"` +} + +type CustomActionParameters struct { + Name string `json:"name"` + Required bool `json:"required"` + Type string `json:"type"` + Validationformat string `json:"validationformat"` + Valueoptions []string `json:"valueoptions"` +} + +type ListExtensionsParams struct { + p map[string]interface{} +} + +func (p *ListExtensionsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["details"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("details", vv) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + return u +} + +func (p *ListExtensionsParams) SetDetails(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *ListExtensionsParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *ListExtensionsParams) GetDetails() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].([]string) + return value, ok +} + +func (p *ListExtensionsParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListExtensionsParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListExtensionsParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListExtensionsParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListExtensionsParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListExtensionsParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListExtensionsParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListExtensionsParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ListExtensionsParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ListExtensionsParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListExtensionsParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListExtensionsParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListExtensionsParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListExtensionsParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListExtensionsParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +// You should always use this function to get a new ListExtensionsParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewListExtensionsParams() *ListExtensionsParams { + p := &ListExtensionsParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ExtensionService) GetExtensionID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListExtensionsParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListExtensions(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.Extensions[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.Extensions { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ExtensionService) GetExtensionByName(name string, opts ...OptionFunc) (*Extension, int, error) { + id, count, err := s.GetExtensionID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetExtensionByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *ExtensionService) GetExtensionByID(id string, opts ...OptionFunc) (*Extension, int, error) { + p := &ListExtensionsParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListExtensions(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.Extensions[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for Extension UUID: %s!", id) +} + +// Lists extensions +func (s *ExtensionService) ListExtensions(p *ListExtensionsParams) (*ListExtensionsResponse, error) { + resp, err := s.cs.newRequest("listExtensions", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListExtensionsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListExtensionsResponse struct { + Count int `json:"count"` + Extensions []*Extension `json:"extension"` +} + +type Extension struct { + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Resources []ExtensionResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` +} + +type ExtensionResources struct { + Created string `json:"created"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Name string `json:"name"` + Type string `json:"type"` +} + +type RegisterExtensionParams struct { + p map[string]interface{} +} + +func (p *RegisterExtensionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["resourceid"]; found { + u.Set("resourceid", v.(string)) + } + if v, found := p.p["resourcetype"]; found { + u.Set("resourcetype", v.(string)) + } + return u +} + +func (p *RegisterExtensionParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *RegisterExtensionParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *RegisterExtensionParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + +func (p *RegisterExtensionParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *RegisterExtensionParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *RegisterExtensionParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *RegisterExtensionParams) SetResourceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourceid"] = v +} + +func (p *RegisterExtensionParams) ResetResourceid() { + if p.p != nil && p.p["resourceid"] != nil { + delete(p.p, "resourceid") + } +} + +func (p *RegisterExtensionParams) GetResourceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourceid"].(string) + return value, ok +} + +func (p *RegisterExtensionParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *RegisterExtensionParams) ResetResourcetype() { + if p.p != nil && p.p["resourcetype"] != nil { + delete(p.p, "resourcetype") + } +} + +func (p *RegisterExtensionParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + +// You should always use this function to get a new RegisterExtensionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewRegisterExtensionParams(extensionid string, resourceid string, resourcetype string) *RegisterExtensionParams { + p := &RegisterExtensionParams{} + p.p = make(map[string]interface{}) + p.p["extensionid"] = extensionid + p.p["resourceid"] = resourceid + p.p["resourcetype"] = resourcetype + return p +} + +// Register an extension with a resource +func (s *ExtensionService) RegisterExtension(p *RegisterExtensionParams) (*RegisterExtensionResponse, error) { + resp, err := s.cs.newPostRequest("registerExtension", p.toURLValues()) + if err != nil { + return nil, err + } + + var r RegisterExtensionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type RegisterExtensionResponse struct { + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Resources []RegisterExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` +} + +type RegisterExtensionResponseResources struct { + Created string `json:"created"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Name string `json:"name"` + Type string `json:"type"` +} + +type RunCustomActionParams struct { + p map[string]interface{} +} + +func (p *RunCustomActionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["customactionid"]; found { + u.Set("customactionid", v.(string)) + } + if v, found := p.p["parameters"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("parameters[%d].key", i), k) + u.Set(fmt.Sprintf("parameters[%d].value", i), m[k]) + } + } + if v, found := p.p["resourceid"]; found { + u.Set("resourceid", v.(string)) + } + if v, found := p.p["resourcetype"]; found { + u.Set("resourcetype", v.(string)) + } + return u +} + +func (p *RunCustomActionParams) SetCustomactionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["customactionid"] = v +} + +func (p *RunCustomActionParams) ResetCustomactionid() { + if p.p != nil && p.p["customactionid"] != nil { + delete(p.p, "customactionid") + } +} + +func (p *RunCustomActionParams) GetCustomactionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["customactionid"].(string) + return value, ok +} + +func (p *RunCustomActionParams) SetParameters(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["parameters"] = v +} + +func (p *RunCustomActionParams) ResetParameters() { + if p.p != nil && p.p["parameters"] != nil { + delete(p.p, "parameters") + } +} + +func (p *RunCustomActionParams) GetParameters() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["parameters"].(map[string]string) + return value, ok +} + +func (p *RunCustomActionParams) SetResourceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourceid"] = v +} + +func (p *RunCustomActionParams) ResetResourceid() { + if p.p != nil && p.p["resourceid"] != nil { + delete(p.p, "resourceid") + } +} + +func (p *RunCustomActionParams) GetResourceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourceid"].(string) + return value, ok +} + +func (p *RunCustomActionParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *RunCustomActionParams) ResetResourcetype() { + if p.p != nil && p.p["resourcetype"] != nil { + delete(p.p, "resourcetype") + } +} + +func (p *RunCustomActionParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + +// You should always use this function to get a new RunCustomActionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewRunCustomActionParams(customactionid string, resourceid string) *RunCustomActionParams { + p := &RunCustomActionParams{} + p.p = make(map[string]interface{}) + p.p["customactionid"] = customactionid + p.p["resourceid"] = resourceid + return p +} + +// Run the custom action +func (s *ExtensionService) RunCustomAction(p *RunCustomActionParams) (*RunCustomActionResponse, error) { + resp, err := s.cs.newPostRequest("runCustomAction", p.toURLValues()) + if err != nil { + return nil, err + } + + var r RunCustomActionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type RunCustomActionResponse struct { + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Result map[string]string `json:"result"` + Success bool `json:"success"` +} + +type UnregisterExtensionParams struct { + p map[string]interface{} +} + +func (p *UnregisterExtensionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["extensionid"]; found { + u.Set("extensionid", v.(string)) + } + if v, found := p.p["resourceid"]; found { + u.Set("resourceid", v.(string)) + } + if v, found := p.p["resourcetype"]; found { + u.Set("resourcetype", v.(string)) + } + return u +} + +func (p *UnregisterExtensionParams) SetExtensionid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extensionid"] = v +} + +func (p *UnregisterExtensionParams) ResetExtensionid() { + if p.p != nil && p.p["extensionid"] != nil { + delete(p.p, "extensionid") + } +} + +func (p *UnregisterExtensionParams) GetExtensionid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extensionid"].(string) + return value, ok +} + +func (p *UnregisterExtensionParams) SetResourceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourceid"] = v +} + +func (p *UnregisterExtensionParams) ResetResourceid() { + if p.p != nil && p.p["resourceid"] != nil { + delete(p.p, "resourceid") + } +} + +func (p *UnregisterExtensionParams) GetResourceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourceid"].(string) + return value, ok +} + +func (p *UnregisterExtensionParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *UnregisterExtensionParams) ResetResourcetype() { + if p.p != nil && p.p["resourcetype"] != nil { + delete(p.p, "resourcetype") + } +} + +func (p *UnregisterExtensionParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + +// You should always use this function to get a new UnregisterExtensionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewUnregisterExtensionParams(extensionid string, resourceid string, resourcetype string) *UnregisterExtensionParams { + p := &UnregisterExtensionParams{} + p.p = make(map[string]interface{}) + p.p["extensionid"] = extensionid + p.p["resourceid"] = resourceid + p.p["resourcetype"] = resourcetype + return p +} + +// Unregister an extension with a resource +func (s *ExtensionService) UnregisterExtension(p *UnregisterExtensionParams) (*UnregisterExtensionResponse, error) { + resp, err := s.cs.newPostRequest("unregisterExtension", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UnregisterExtensionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UnregisterExtensionResponse struct { + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Resources []UnregisterExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` +} + +type UnregisterExtensionResponseResources struct { + Created string `json:"created"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Name string `json:"name"` + Type string `json:"type"` +} + +type UpdateCustomActionParams struct { + p map[string]interface{} +} + +func (p *UpdateCustomActionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["allowedroletypes"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("allowedroletypes", vv) + } + if v, found := p.p["cleanupdetails"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("cleanupdetails", vv) + } + if v, found := p.p["cleanupparameters"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("cleanupparameters", vv) + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } + if v, found := p.p["enabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("enabled", vv) + } + if v, found := p.p["errormessage"]; found { + u.Set("errormessage", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["parameters"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("parameters[%d].key", i), k) + u.Set(fmt.Sprintf("parameters[%d].value", i), m[k]) + } + } + if v, found := p.p["resourcetype"]; found { + u.Set("resourcetype", v.(string)) + } + if v, found := p.p["successmessage"]; found { + u.Set("successmessage", v.(string)) + } + if v, found := p.p["timeout"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("timeout", vv) + } + return u +} + +func (p *UpdateCustomActionParams) SetAllowedroletypes(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["allowedroletypes"] = v +} + +func (p *UpdateCustomActionParams) ResetAllowedroletypes() { + if p.p != nil && p.p["allowedroletypes"] != nil { + delete(p.p, "allowedroletypes") + } +} + +func (p *UpdateCustomActionParams) GetAllowedroletypes() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["allowedroletypes"].([]string) + return value, ok +} + +func (p *UpdateCustomActionParams) SetCleanupdetails(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cleanupdetails"] = v +} + +func (p *UpdateCustomActionParams) ResetCleanupdetails() { + if p.p != nil && p.p["cleanupdetails"] != nil { + delete(p.p, "cleanupdetails") + } +} + +func (p *UpdateCustomActionParams) GetCleanupdetails() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cleanupdetails"].(bool) + return value, ok +} + +func (p *UpdateCustomActionParams) SetCleanupparameters(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cleanupparameters"] = v +} + +func (p *UpdateCustomActionParams) ResetCleanupparameters() { + if p.p != nil && p.p["cleanupparameters"] != nil { + delete(p.p, "cleanupparameters") + } +} + +func (p *UpdateCustomActionParams) GetCleanupparameters() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cleanupparameters"].(bool) + return value, ok +} + +func (p *UpdateCustomActionParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *UpdateCustomActionParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *UpdateCustomActionParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *UpdateCustomActionParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *UpdateCustomActionParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *UpdateCustomActionParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + +func (p *UpdateCustomActionParams) SetEnabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enabled"] = v +} + +func (p *UpdateCustomActionParams) ResetEnabled() { + if p.p != nil && p.p["enabled"] != nil { + delete(p.p, "enabled") + } +} + +func (p *UpdateCustomActionParams) GetEnabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enabled"].(bool) + return value, ok +} + +func (p *UpdateCustomActionParams) SetErrormessage(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["errormessage"] = v +} + +func (p *UpdateCustomActionParams) ResetErrormessage() { + if p.p != nil && p.p["errormessage"] != nil { + delete(p.p, "errormessage") + } +} + +func (p *UpdateCustomActionParams) GetErrormessage() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["errormessage"].(string) + return value, ok +} + +func (p *UpdateCustomActionParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *UpdateCustomActionParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *UpdateCustomActionParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *UpdateCustomActionParams) SetParameters(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["parameters"] = v +} + +func (p *UpdateCustomActionParams) ResetParameters() { + if p.p != nil && p.p["parameters"] != nil { + delete(p.p, "parameters") + } +} + +func (p *UpdateCustomActionParams) GetParameters() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["parameters"].(map[string]string) + return value, ok +} + +func (p *UpdateCustomActionParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *UpdateCustomActionParams) ResetResourcetype() { + if p.p != nil && p.p["resourcetype"] != nil { + delete(p.p, "resourcetype") + } +} + +func (p *UpdateCustomActionParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + +func (p *UpdateCustomActionParams) SetSuccessmessage(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["successmessage"] = v +} + +func (p *UpdateCustomActionParams) ResetSuccessmessage() { + if p.p != nil && p.p["successmessage"] != nil { + delete(p.p, "successmessage") + } +} + +func (p *UpdateCustomActionParams) GetSuccessmessage() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["successmessage"].(string) + return value, ok +} + +func (p *UpdateCustomActionParams) SetTimeout(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["timeout"] = v +} + +func (p *UpdateCustomActionParams) ResetTimeout() { + if p.p != nil && p.p["timeout"] != nil { + delete(p.p, "timeout") + } +} + +func (p *UpdateCustomActionParams) GetTimeout() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["timeout"].(int) + return value, ok +} + +// You should always use this function to get a new UpdateCustomActionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewUpdateCustomActionParams(id string) *UpdateCustomActionParams { + p := &UpdateCustomActionParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Update the custom action +func (s *ExtensionService) UpdateCustomAction(p *UpdateCustomActionParams) (*UpdateCustomActionResponse, error) { + resp, err := s.cs.newPostRequest("updateCustomAction", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateCustomActionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UpdateCustomActionResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *UpdateCustomActionResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias UpdateCustomActionResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type UpdateExtensionParams struct { + p map[string]interface{} +} + +func (p *UpdateExtensionParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["cleanupdetails"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("cleanupdetails", vv) + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["orchestratorrequirespreparevm"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("orchestratorrequirespreparevm", vv) + } + if v, found := p.p["state"]; found { + u.Set("state", v.(string)) + } + return u +} + +func (p *UpdateExtensionParams) SetCleanupdetails(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cleanupdetails"] = v +} + +func (p *UpdateExtensionParams) ResetCleanupdetails() { + if p.p != nil && p.p["cleanupdetails"] != nil { + delete(p.p, "cleanupdetails") + } +} + +func (p *UpdateExtensionParams) GetCleanupdetails() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cleanupdetails"].(bool) + return value, ok +} + +func (p *UpdateExtensionParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *UpdateExtensionParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *UpdateExtensionParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *UpdateExtensionParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *UpdateExtensionParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *UpdateExtensionParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + +func (p *UpdateExtensionParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *UpdateExtensionParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *UpdateExtensionParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *UpdateExtensionParams) SetOrchestratorrequirespreparevm(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["orchestratorrequirespreparevm"] = v +} + +func (p *UpdateExtensionParams) ResetOrchestratorrequirespreparevm() { + if p.p != nil && p.p["orchestratorrequirespreparevm"] != nil { + delete(p.p, "orchestratorrequirespreparevm") + } +} + +func (p *UpdateExtensionParams) GetOrchestratorrequirespreparevm() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["orchestratorrequirespreparevm"].(bool) + return value, ok +} + +func (p *UpdateExtensionParams) SetState(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["state"] = v +} + +func (p *UpdateExtensionParams) ResetState() { + if p.p != nil && p.p["state"] != nil { + delete(p.p, "state") + } +} + +func (p *UpdateExtensionParams) GetState() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["state"].(string) + return value, ok +} + +// You should always use this function to get a new UpdateExtensionParams instance, +// as then you are sure you have configured all required params +func (s *ExtensionService) NewUpdateExtensionParams(id string) *UpdateExtensionParams { + p := &UpdateExtensionParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Update the extension +func (s *ExtensionService) UpdateExtension(p *UpdateExtensionParams) (*UpdateExtensionResponse, error) { + resp, err := s.cs.newPostRequest("updateExtension", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateExtensionResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UpdateExtensionResponse struct { + Created string `json:"created"` + Description string `json:"description"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Isuserdefined bool `json:"isuserdefined"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Path string `json:"path"` + Pathready bool `json:"pathready"` + Removed string `json:"removed"` + Resources []UpdateExtensionResponseResources `json:"resources"` + State string `json:"state"` + Type string `json:"type"` +} + +type UpdateExtensionResponseResources struct { + Created string `json:"created"` + Details map[string]string `json:"details"` + Id string `json:"id"` + Name string `json:"name"` + Type string `json:"type"` +} diff --git a/cloudstack/ExtensionService_mock.go b/cloudstack/ExtensionService_mock.go new file mode 100644 index 00000000..c9e70c9d --- /dev/null +++ b/cloudstack/ExtensionService_mock.go @@ -0,0 +1,504 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +// Code generated by MockGen. DO NOT EDIT. +// Source: ./cloudstack/ExtensionService.go +// +// Generated by this command: +// +// mockgen -destination=./cloudstack/ExtensionService_mock.go -package=cloudstack -copyright_file=header.txt -source=./cloudstack/ExtensionService.go +// + +// Package cloudstack is a generated GoMock package. +package cloudstack + +import ( + reflect "reflect" + + gomock "go.uber.org/mock/gomock" +) + +// MockExtensionServiceIface is a mock of ExtensionServiceIface interface. +type MockExtensionServiceIface struct { + ctrl *gomock.Controller + recorder *MockExtensionServiceIfaceMockRecorder + isgomock struct{} +} + +// MockExtensionServiceIfaceMockRecorder is the mock recorder for MockExtensionServiceIface. +type MockExtensionServiceIfaceMockRecorder struct { + mock *MockExtensionServiceIface +} + +// NewMockExtensionServiceIface creates a new mock instance. +func NewMockExtensionServiceIface(ctrl *gomock.Controller) *MockExtensionServiceIface { + mock := &MockExtensionServiceIface{ctrl: ctrl} + mock.recorder = &MockExtensionServiceIfaceMockRecorder{mock} + return mock +} + +// EXPECT returns an object that allows the caller to indicate expected use. +func (m *MockExtensionServiceIface) EXPECT() *MockExtensionServiceIfaceMockRecorder { + return m.recorder +} + +// AddCustomAction mocks base method. +func (m *MockExtensionServiceIface) AddCustomAction(p *AddCustomActionParams) (*AddCustomActionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "AddCustomAction", p) + ret0, _ := ret[0].(*AddCustomActionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// AddCustomAction indicates an expected call of AddCustomAction. +func (mr *MockExtensionServiceIfaceMockRecorder) AddCustomAction(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddCustomAction", reflect.TypeOf((*MockExtensionServiceIface)(nil).AddCustomAction), p) +} + +// CreateExtension mocks base method. +func (m *MockExtensionServiceIface) CreateExtension(p *CreateExtensionParams) (*CreateExtensionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateExtension", p) + ret0, _ := ret[0].(*CreateExtensionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateExtension indicates an expected call of CreateExtension. +func (mr *MockExtensionServiceIfaceMockRecorder) CreateExtension(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateExtension", reflect.TypeOf((*MockExtensionServiceIface)(nil).CreateExtension), p) +} + +// DeleteCustomAction mocks base method. +func (m *MockExtensionServiceIface) DeleteCustomAction(p *DeleteCustomActionParams) (*DeleteCustomActionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteCustomAction", p) + ret0, _ := ret[0].(*DeleteCustomActionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteCustomAction indicates an expected call of DeleteCustomAction. +func (mr *MockExtensionServiceIfaceMockRecorder) DeleteCustomAction(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteCustomAction", reflect.TypeOf((*MockExtensionServiceIface)(nil).DeleteCustomAction), p) +} + +// DeleteExtension mocks base method. +func (m *MockExtensionServiceIface) DeleteExtension(p *DeleteExtensionParams) (*DeleteExtensionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteExtension", p) + ret0, _ := ret[0].(*DeleteExtensionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteExtension indicates an expected call of DeleteExtension. +func (mr *MockExtensionServiceIfaceMockRecorder) DeleteExtension(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteExtension", reflect.TypeOf((*MockExtensionServiceIface)(nil).DeleteExtension), p) +} + +// GetCustomActionByID mocks base method. +func (m *MockExtensionServiceIface) GetCustomActionByID(id string, opts ...OptionFunc) (*CustomAction, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetCustomActionByID", varargs...) + ret0, _ := ret[0].(*CustomAction) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetCustomActionByID indicates an expected call of GetCustomActionByID. +func (mr *MockExtensionServiceIfaceMockRecorder) GetCustomActionByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetCustomActionByID", reflect.TypeOf((*MockExtensionServiceIface)(nil).GetCustomActionByID), varargs...) +} + +// GetCustomActionByName mocks base method. +func (m *MockExtensionServiceIface) GetCustomActionByName(name string, opts ...OptionFunc) (*CustomAction, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetCustomActionByName", varargs...) + ret0, _ := ret[0].(*CustomAction) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetCustomActionByName indicates an expected call of GetCustomActionByName. +func (mr *MockExtensionServiceIfaceMockRecorder) GetCustomActionByName(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetCustomActionByName", reflect.TypeOf((*MockExtensionServiceIface)(nil).GetCustomActionByName), varargs...) +} + +// GetCustomActionID mocks base method. +func (m *MockExtensionServiceIface) GetCustomActionID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetCustomActionID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetCustomActionID indicates an expected call of GetCustomActionID. +func (mr *MockExtensionServiceIfaceMockRecorder) GetCustomActionID(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetCustomActionID", reflect.TypeOf((*MockExtensionServiceIface)(nil).GetCustomActionID), varargs...) +} + +// GetExtensionByID mocks base method. +func (m *MockExtensionServiceIface) GetExtensionByID(id string, opts ...OptionFunc) (*Extension, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetExtensionByID", varargs...) + ret0, _ := ret[0].(*Extension) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetExtensionByID indicates an expected call of GetExtensionByID. +func (mr *MockExtensionServiceIfaceMockRecorder) GetExtensionByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetExtensionByID", reflect.TypeOf((*MockExtensionServiceIface)(nil).GetExtensionByID), varargs...) +} + +// GetExtensionByName mocks base method. +func (m *MockExtensionServiceIface) GetExtensionByName(name string, opts ...OptionFunc) (*Extension, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetExtensionByName", varargs...) + ret0, _ := ret[0].(*Extension) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetExtensionByName indicates an expected call of GetExtensionByName. +func (mr *MockExtensionServiceIfaceMockRecorder) GetExtensionByName(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetExtensionByName", reflect.TypeOf((*MockExtensionServiceIface)(nil).GetExtensionByName), varargs...) +} + +// GetExtensionID mocks base method. +func (m *MockExtensionServiceIface) GetExtensionID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetExtensionID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetExtensionID indicates an expected call of GetExtensionID. +func (mr *MockExtensionServiceIfaceMockRecorder) GetExtensionID(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetExtensionID", reflect.TypeOf((*MockExtensionServiceIface)(nil).GetExtensionID), varargs...) +} + +// ListCustomActions mocks base method. +func (m *MockExtensionServiceIface) ListCustomActions(p *ListCustomActionsParams) (*ListCustomActionsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListCustomActions", p) + ret0, _ := ret[0].(*ListCustomActionsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListCustomActions indicates an expected call of ListCustomActions. +func (mr *MockExtensionServiceIfaceMockRecorder) ListCustomActions(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListCustomActions", reflect.TypeOf((*MockExtensionServiceIface)(nil).ListCustomActions), p) +} + +// ListExtensions mocks base method. +func (m *MockExtensionServiceIface) ListExtensions(p *ListExtensionsParams) (*ListExtensionsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListExtensions", p) + ret0, _ := ret[0].(*ListExtensionsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListExtensions indicates an expected call of ListExtensions. +func (mr *MockExtensionServiceIfaceMockRecorder) ListExtensions(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListExtensions", reflect.TypeOf((*MockExtensionServiceIface)(nil).ListExtensions), p) +} + +// NewAddCustomActionParams mocks base method. +func (m *MockExtensionServiceIface) NewAddCustomActionParams(extensionid, name string) *AddCustomActionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewAddCustomActionParams", extensionid, name) + ret0, _ := ret[0].(*AddCustomActionParams) + return ret0 +} + +// NewAddCustomActionParams indicates an expected call of NewAddCustomActionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewAddCustomActionParams(extensionid, name any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAddCustomActionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewAddCustomActionParams), extensionid, name) +} + +// NewCreateExtensionParams mocks base method. +func (m *MockExtensionServiceIface) NewCreateExtensionParams(name, extensionType string) *CreateExtensionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateExtensionParams", name, extensionType) + ret0, _ := ret[0].(*CreateExtensionParams) + return ret0 +} + +// NewCreateExtensionParams indicates an expected call of NewCreateExtensionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewCreateExtensionParams(name, extensionType any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateExtensionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewCreateExtensionParams), name, extensionType) +} + +// NewDeleteCustomActionParams mocks base method. +func (m *MockExtensionServiceIface) NewDeleteCustomActionParams() *DeleteCustomActionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteCustomActionParams") + ret0, _ := ret[0].(*DeleteCustomActionParams) + return ret0 +} + +// NewDeleteCustomActionParams indicates an expected call of NewDeleteCustomActionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewDeleteCustomActionParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteCustomActionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewDeleteCustomActionParams)) +} + +// NewDeleteExtensionParams mocks base method. +func (m *MockExtensionServiceIface) NewDeleteExtensionParams() *DeleteExtensionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteExtensionParams") + ret0, _ := ret[0].(*DeleteExtensionParams) + return ret0 +} + +// NewDeleteExtensionParams indicates an expected call of NewDeleteExtensionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewDeleteExtensionParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteExtensionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewDeleteExtensionParams)) +} + +// NewListCustomActionsParams mocks base method. +func (m *MockExtensionServiceIface) NewListCustomActionsParams() *ListCustomActionsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListCustomActionsParams") + ret0, _ := ret[0].(*ListCustomActionsParams) + return ret0 +} + +// NewListCustomActionsParams indicates an expected call of NewListCustomActionsParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewListCustomActionsParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListCustomActionsParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewListCustomActionsParams)) +} + +// NewListExtensionsParams mocks base method. +func (m *MockExtensionServiceIface) NewListExtensionsParams() *ListExtensionsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListExtensionsParams") + ret0, _ := ret[0].(*ListExtensionsParams) + return ret0 +} + +// NewListExtensionsParams indicates an expected call of NewListExtensionsParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewListExtensionsParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListExtensionsParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewListExtensionsParams)) +} + +// NewRegisterExtensionParams mocks base method. +func (m *MockExtensionServiceIface) NewRegisterExtensionParams(extensionid, resourceid, resourcetype string) *RegisterExtensionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewRegisterExtensionParams", extensionid, resourceid, resourcetype) + ret0, _ := ret[0].(*RegisterExtensionParams) + return ret0 +} + +// NewRegisterExtensionParams indicates an expected call of NewRegisterExtensionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewRegisterExtensionParams(extensionid, resourceid, resourcetype any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRegisterExtensionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewRegisterExtensionParams), extensionid, resourceid, resourcetype) +} + +// NewRunCustomActionParams mocks base method. +func (m *MockExtensionServiceIface) NewRunCustomActionParams(customactionid, resourceid string) *RunCustomActionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewRunCustomActionParams", customactionid, resourceid) + ret0, _ := ret[0].(*RunCustomActionParams) + return ret0 +} + +// NewRunCustomActionParams indicates an expected call of NewRunCustomActionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewRunCustomActionParams(customactionid, resourceid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRunCustomActionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewRunCustomActionParams), customactionid, resourceid) +} + +// NewUnregisterExtensionParams mocks base method. +func (m *MockExtensionServiceIface) NewUnregisterExtensionParams(extensionid, resourceid, resourcetype string) *UnregisterExtensionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUnregisterExtensionParams", extensionid, resourceid, resourcetype) + ret0, _ := ret[0].(*UnregisterExtensionParams) + return ret0 +} + +// NewUnregisterExtensionParams indicates an expected call of NewUnregisterExtensionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewUnregisterExtensionParams(extensionid, resourceid, resourcetype any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUnregisterExtensionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewUnregisterExtensionParams), extensionid, resourceid, resourcetype) +} + +// NewUpdateCustomActionParams mocks base method. +func (m *MockExtensionServiceIface) NewUpdateCustomActionParams(id string) *UpdateCustomActionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateCustomActionParams", id) + ret0, _ := ret[0].(*UpdateCustomActionParams) + return ret0 +} + +// NewUpdateCustomActionParams indicates an expected call of NewUpdateCustomActionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewUpdateCustomActionParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateCustomActionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewUpdateCustomActionParams), id) +} + +// NewUpdateExtensionParams mocks base method. +func (m *MockExtensionServiceIface) NewUpdateExtensionParams(id string) *UpdateExtensionParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateExtensionParams", id) + ret0, _ := ret[0].(*UpdateExtensionParams) + return ret0 +} + +// NewUpdateExtensionParams indicates an expected call of NewUpdateExtensionParams. +func (mr *MockExtensionServiceIfaceMockRecorder) NewUpdateExtensionParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateExtensionParams", reflect.TypeOf((*MockExtensionServiceIface)(nil).NewUpdateExtensionParams), id) +} + +// RegisterExtension mocks base method. +func (m *MockExtensionServiceIface) RegisterExtension(p *RegisterExtensionParams) (*RegisterExtensionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "RegisterExtension", p) + ret0, _ := ret[0].(*RegisterExtensionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// RegisterExtension indicates an expected call of RegisterExtension. +func (mr *MockExtensionServiceIfaceMockRecorder) RegisterExtension(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RegisterExtension", reflect.TypeOf((*MockExtensionServiceIface)(nil).RegisterExtension), p) +} + +// RunCustomAction mocks base method. +func (m *MockExtensionServiceIface) RunCustomAction(p *RunCustomActionParams) (*RunCustomActionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "RunCustomAction", p) + ret0, _ := ret[0].(*RunCustomActionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// RunCustomAction indicates an expected call of RunCustomAction. +func (mr *MockExtensionServiceIfaceMockRecorder) RunCustomAction(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RunCustomAction", reflect.TypeOf((*MockExtensionServiceIface)(nil).RunCustomAction), p) +} + +// UnregisterExtension mocks base method. +func (m *MockExtensionServiceIface) UnregisterExtension(p *UnregisterExtensionParams) (*UnregisterExtensionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UnregisterExtension", p) + ret0, _ := ret[0].(*UnregisterExtensionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UnregisterExtension indicates an expected call of UnregisterExtension. +func (mr *MockExtensionServiceIfaceMockRecorder) UnregisterExtension(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UnregisterExtension", reflect.TypeOf((*MockExtensionServiceIface)(nil).UnregisterExtension), p) +} + +// UpdateCustomAction mocks base method. +func (m *MockExtensionServiceIface) UpdateCustomAction(p *UpdateCustomActionParams) (*UpdateCustomActionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateCustomAction", p) + ret0, _ := ret[0].(*UpdateCustomActionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateCustomAction indicates an expected call of UpdateCustomAction. +func (mr *MockExtensionServiceIfaceMockRecorder) UpdateCustomAction(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateCustomAction", reflect.TypeOf((*MockExtensionServiceIface)(nil).UpdateCustomAction), p) +} + +// UpdateExtension mocks base method. +func (m *MockExtensionServiceIface) UpdateExtension(p *UpdateExtensionParams) (*UpdateExtensionResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateExtension", p) + ret0, _ := ret[0].(*UpdateExtensionResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateExtension indicates an expected call of UpdateExtension. +func (mr *MockExtensionServiceIfaceMockRecorder) UpdateExtension(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateExtension", reflect.TypeOf((*MockExtensionServiceIface)(nil).UpdateExtension), p) +} diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index 4d531db6..c7ef9f38 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -125,6 +125,7 @@ type CloudStackClient struct { DiskOffering DiskOfferingServiceIface Domain DomainServiceIface Event EventServiceIface + Extension ExtensionServiceIface Firewall FirewallServiceIface GPU GPUServiceIface GuestOS GuestOSServiceIface @@ -255,6 +256,7 @@ func newClient(apiurl string, apikey string, secret string, async bool, verifyss cs.DiskOffering = NewDiskOfferingService(cs) cs.Domain = NewDomainService(cs) cs.Event = NewEventService(cs) + cs.Extension = NewExtensionService(cs) cs.Firewall = NewFirewallService(cs) cs.GPU = NewGPUService(cs) cs.GuestOS = NewGuestOSService(cs) @@ -358,6 +360,7 @@ func newMockClient(ctrl *gomock.Controller) *CloudStackClient { cs.DiskOffering = NewMockDiskOfferingServiceIface(ctrl) cs.Domain = NewMockDomainServiceIface(ctrl) cs.Event = NewMockEventServiceIface(ctrl) + cs.Extension = NewMockExtensionServiceIface(ctrl) cs.Firewall = NewMockFirewallServiceIface(ctrl) cs.GPU = NewMockGPUServiceIface(ctrl) cs.GuestOS = NewMockGuestOSServiceIface(ctrl) @@ -1021,6 +1024,14 @@ func NewEventService(cs *CloudStackClient) EventServiceIface { return &EventService{cs: cs} } +type ExtensionService struct { + cs *CloudStackClient +} + +func NewExtensionService(cs *CloudStackClient) ExtensionServiceIface { + return &ExtensionService{cs: cs} +} + type FirewallService struct { cs *CloudStackClient } diff --git a/generate/layout.go b/generate/layout.go index 40a6d136..77c56320 100644 --- a/generate/layout.go +++ b/generate/layout.go @@ -29,6 +29,19 @@ var layout = apiInfo{ "releaseBgpPeer", "updateBgpPeer", }, + "ExtensionService": { + "addCustomAction", + "createExtension", + "deleteCustomAction", + "deleteExtension", + "listCustomActions", + "listExtensions", + "registerExtension", + "runCustomAction", + "unregisterExtension", + "updateCustomAction", + "updateExtension", + }, "LoadBalancerService": { "assignCertToLoadBalancer", "assignToGlobalLoadBalancerRule", diff --git a/test/ExtensionService_test.go b/test/ExtensionService_test.go new file mode 100644 index 00000000..7eff1817 --- /dev/null +++ b/test/ExtensionService_test.go @@ -0,0 +1,191 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package test + +import ( + "testing" + + "github.com/apache/cloudstack-go/v2/cloudstack" +) + +func TestExtensionService(t *testing.T) { + service := "ExtensionService" + response, err := readData(service) + if err != nil { + t.Skipf("Skipping test as %v", err) + } + server := CreateTestServer(t, response) + client := cloudstack.NewClient(server.URL, "APIKEY", "SECRETKEY", true) + defer server.Close() + + testaddCustomAction := func(t *testing.T) { + if _, ok := response["addCustomAction"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewAddCustomActionParams("extensionid", "name") + r, err := client.Extension.AddCustomAction(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("AddCustomAction", testaddCustomAction) + + testcreateExtension := func(t *testing.T) { + if _, ok := response["createExtension"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewCreateExtensionParams("name", "type") + r, err := client.Extension.CreateExtension(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("CreateExtension", testcreateExtension) + + testdeleteCustomAction := func(t *testing.T) { + if _, ok := response["deleteCustomAction"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewDeleteCustomActionParams() + _, err := client.Extension.DeleteCustomAction(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteCustomAction", testdeleteCustomAction) + + testdeleteExtension := func(t *testing.T) { + if _, ok := response["deleteExtension"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewDeleteExtensionParams() + r, err := client.Extension.DeleteExtension(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("DeleteExtension", testdeleteExtension) + + testlistCustomActions := func(t *testing.T) { + if _, ok := response["listCustomActions"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewListCustomActionsParams() + _, err := client.Extension.ListCustomActions(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListCustomActions", testlistCustomActions) + + testlistExtensions := func(t *testing.T) { + if _, ok := response["listExtensions"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewListExtensionsParams() + _, err := client.Extension.ListExtensions(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListExtensions", testlistExtensions) + + testregisterExtension := func(t *testing.T) { + if _, ok := response["registerExtension"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewRegisterExtensionParams("extensionid", "resourceid", "resourcetype") + r, err := client.Extension.RegisterExtension(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("RegisterExtension", testregisterExtension) + + testrunCustomAction := func(t *testing.T) { + if _, ok := response["runCustomAction"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewRunCustomActionParams("customactionid", "resourceid") + r, err := client.Extension.RunCustomAction(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("RunCustomAction", testrunCustomAction) + + testunregisterExtension := func(t *testing.T) { + if _, ok := response["unregisterExtension"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewUnregisterExtensionParams("extensionid", "resourceid", "resourcetype") + r, err := client.Extension.UnregisterExtension(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UnregisterExtension", testunregisterExtension) + + testupdateCustomAction := func(t *testing.T) { + if _, ok := response["updateCustomAction"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewUpdateCustomActionParams("id") + _, err := client.Extension.UpdateCustomAction(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("UpdateCustomAction", testupdateCustomAction) + + testupdateExtension := func(t *testing.T) { + if _, ok := response["updateExtension"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Extension.NewUpdateExtensionParams("id") + r, err := client.Extension.UpdateExtension(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UpdateExtension", testupdateExtension) + +} From ae80b390d8d276294e158b32ccf80c26e216f6a7 Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Tue, 23 Sep 2025 08:45:27 -0400 Subject: [PATCH 6/6] Add support for backup & recovery service (#122) * Add support for backup & recovery service * add additional apis to the vm service --- cloudstack/BackupService.go | 4796 ++++++++++++++++++++++ cloudstack/BackupService_mock.go | 791 ++++ cloudstack/VirtualMachineService.go | 218 + cloudstack/VirtualMachineService_mock.go | 58 + cloudstack/VolumeService.go | 134 + cloudstack/VolumeService_mock.go | 29 + cloudstack/cloudstack.go | 11 + generate/layout.go | 23 + test/BackupService_test.go | 272 ++ test/VirtualMachineService_test.go | 24 + test/VolumeService_test.go | 12 + 11 files changed, 6368 insertions(+) create mode 100644 cloudstack/BackupService.go create mode 100644 cloudstack/BackupService_mock.go create mode 100644 test/BackupService_test.go diff --git a/cloudstack/BackupService.go b/cloudstack/BackupService.go new file mode 100644 index 00000000..454b12e9 --- /dev/null +++ b/cloudstack/BackupService.go @@ -0,0 +1,4796 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package cloudstack + +import ( + "encoding/json" + "fmt" + "net/url" + "strconv" + "strings" +) + +type BackupServiceIface interface { + AddBackupRepository(p *AddBackupRepositoryParams) (*AddBackupRepositoryResponse, error) + NewAddBackupRepositoryParams(address string, name string, backupType string, zoneid string) *AddBackupRepositoryParams + CreateBackup(p *CreateBackupParams) (*CreateBackupResponse, error) + NewCreateBackupParams(virtualmachineid string) *CreateBackupParams + CreateBackupSchedule(p *CreateBackupScheduleParams) (*CreateBackupScheduleResponse, error) + NewCreateBackupScheduleParams(intervaltype string, schedule string, timezone string, virtualmachineid string) *CreateBackupScheduleParams + CreateVMFromBackup(p *CreateVMFromBackupParams) (*CreateVMFromBackupResponse, error) + NewCreateVMFromBackupParams(backupid string, zoneid string) *CreateVMFromBackupParams + DeleteBackup(p *DeleteBackupParams) (*DeleteBackupResponse, error) + NewDeleteBackupParams(id string) *DeleteBackupParams + DeleteBackupOffering(p *DeleteBackupOfferingParams) (*DeleteBackupOfferingResponse, error) + NewDeleteBackupOfferingParams(id string) *DeleteBackupOfferingParams + DeleteBackupRepository(p *DeleteBackupRepositoryParams) (*DeleteBackupRepositoryResponse, error) + NewDeleteBackupRepositoryParams(id string) *DeleteBackupRepositoryParams + DeleteBackupSchedule(p *DeleteBackupScheduleParams) (*DeleteBackupScheduleResponse, error) + NewDeleteBackupScheduleParams() *DeleteBackupScheduleParams + ImportBackupOffering(p *ImportBackupOfferingParams) (*ImportBackupOfferingResponse, error) + NewImportBackupOfferingParams(allowuserdrivenbackups bool, description string, externalid string, name string, zoneid string) *ImportBackupOfferingParams + ListBackupOfferings(p *ListBackupOfferingsParams) (*ListBackupOfferingsResponse, error) + NewListBackupOfferingsParams() *ListBackupOfferingsParams + GetBackupOfferingID(keyword string, opts ...OptionFunc) (string, int, error) + GetBackupOfferingByName(name string, opts ...OptionFunc) (*BackupOffering, int, error) + GetBackupOfferingByID(id string, opts ...OptionFunc) (*BackupOffering, int, error) + ListBackupProviderOfferings(p *ListBackupProviderOfferingsParams) (*ListBackupProviderOfferingsResponse, error) + NewListBackupProviderOfferingsParams(zoneid string) *ListBackupProviderOfferingsParams + GetBackupProviderOfferingID(keyword string, zoneid string, opts ...OptionFunc) (string, int, error) + ListBackupProviders(p *ListBackupProvidersParams) (*ListBackupProvidersResponse, error) + NewListBackupProvidersParams() *ListBackupProvidersParams + ListBackupRepositories(p *ListBackupRepositoriesParams) (*ListBackupRepositoriesResponse, error) + NewListBackupRepositoriesParams() *ListBackupRepositoriesParams + GetBackupRepositoryID(name string, opts ...OptionFunc) (string, int, error) + GetBackupRepositoryByName(name string, opts ...OptionFunc) (*BackupRepository, int, error) + GetBackupRepositoryByID(id string, opts ...OptionFunc) (*BackupRepository, int, error) + ListBackupSchedule(p *ListBackupScheduleParams) (*ListBackupScheduleResponse, error) + NewListBackupScheduleParams(virtualmachineid string) *ListBackupScheduleParams + ListBackups(p *ListBackupsParams) (*ListBackupsResponse, error) + NewListBackupsParams() *ListBackupsParams + GetBackupID(name string, opts ...OptionFunc) (string, int, error) + GetBackupByName(name string, opts ...OptionFunc) (*Backup, int, error) + GetBackupByID(id string, opts ...OptionFunc) (*Backup, int, error) + RestoreBackup(p *RestoreBackupParams) (*RestoreBackupResponse, error) + NewRestoreBackupParams(id string) *RestoreBackupParams + UpdateBackupOffering(p *UpdateBackupOfferingParams) (*UpdateBackupOfferingResponse, error) + NewUpdateBackupOfferingParams(id string) *UpdateBackupOfferingParams + UpdateBackupSchedule(p *UpdateBackupScheduleParams) (*UpdateBackupScheduleResponse, error) + NewUpdateBackupScheduleParams(intervaltype string, schedule string, timezone string, virtualmachineid string) *UpdateBackupScheduleParams +} + +type AddBackupRepositoryParams struct { + p map[string]interface{} +} + +func (p *AddBackupRepositoryParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["address"]; found { + u.Set("address", v.(string)) + } + if v, found := p.p["capacitybytes"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("capacitybytes", vv) + } + if v, found := p.p["mountopts"]; found { + u.Set("mountopts", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["provider"]; found { + u.Set("provider", v.(string)) + } + if v, found := p.p["type"]; found { + u.Set("type", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *AddBackupRepositoryParams) SetAddress(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["address"] = v +} + +func (p *AddBackupRepositoryParams) ResetAddress() { + if p.p != nil && p.p["address"] != nil { + delete(p.p, "address") + } +} + +func (p *AddBackupRepositoryParams) GetAddress() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["address"].(string) + return value, ok +} + +func (p *AddBackupRepositoryParams) SetCapacitybytes(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["capacitybytes"] = v +} + +func (p *AddBackupRepositoryParams) ResetCapacitybytes() { + if p.p != nil && p.p["capacitybytes"] != nil { + delete(p.p, "capacitybytes") + } +} + +func (p *AddBackupRepositoryParams) GetCapacitybytes() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["capacitybytes"].(int64) + return value, ok +} + +func (p *AddBackupRepositoryParams) SetMountopts(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["mountopts"] = v +} + +func (p *AddBackupRepositoryParams) ResetMountopts() { + if p.p != nil && p.p["mountopts"] != nil { + delete(p.p, "mountopts") + } +} + +func (p *AddBackupRepositoryParams) GetMountopts() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["mountopts"].(string) + return value, ok +} + +func (p *AddBackupRepositoryParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *AddBackupRepositoryParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *AddBackupRepositoryParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *AddBackupRepositoryParams) SetProvider(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["provider"] = v +} + +func (p *AddBackupRepositoryParams) ResetProvider() { + if p.p != nil && p.p["provider"] != nil { + delete(p.p, "provider") + } +} + +func (p *AddBackupRepositoryParams) GetProvider() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["provider"].(string) + return value, ok +} + +func (p *AddBackupRepositoryParams) SetType(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["type"] = v +} + +func (p *AddBackupRepositoryParams) ResetType() { + if p.p != nil && p.p["type"] != nil { + delete(p.p, "type") + } +} + +func (p *AddBackupRepositoryParams) GetType() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["type"].(string) + return value, ok +} + +func (p *AddBackupRepositoryParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *AddBackupRepositoryParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *AddBackupRepositoryParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new AddBackupRepositoryParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewAddBackupRepositoryParams(address string, name string, backupType string, zoneid string) *AddBackupRepositoryParams { + p := &AddBackupRepositoryParams{} + p.p = make(map[string]interface{}) + p.p["address"] = address + p.p["name"] = name + p.p["type"] = backupType + p.p["zoneid"] = zoneid + return p +} + +// Adds a backup repository to store NAS backups +func (s *BackupService) AddBackupRepository(p *AddBackupRepositoryParams) (*AddBackupRepositoryResponse, error) { + resp, err := s.cs.newPostRequest("addBackupRepository", p.toURLValues()) + if err != nil { + return nil, err + } + + var r AddBackupRepositoryResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type AddBackupRepositoryResponse struct { + Address string `json:"address"` + Capacitybytes int64 `json:"capacitybytes"` + Created string `json:"created"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Provider string `json:"provider"` + Type string `json:"type"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type CreateBackupParams struct { + p map[string]interface{} +} + +func (p *CreateBackupParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["quiescevm"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("quiescevm", vv) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + return u +} + +func (p *CreateBackupParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *CreateBackupParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *CreateBackupParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *CreateBackupParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *CreateBackupParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *CreateBackupParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *CreateBackupParams) SetQuiescevm(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["quiescevm"] = v +} + +func (p *CreateBackupParams) ResetQuiescevm() { + if p.p != nil && p.p["quiescevm"] != nil { + delete(p.p, "quiescevm") + } +} + +func (p *CreateBackupParams) GetQuiescevm() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["quiescevm"].(bool) + return value, ok +} + +func (p *CreateBackupParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *CreateBackupParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *CreateBackupParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +// You should always use this function to get a new CreateBackupParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewCreateBackupParams(virtualmachineid string) *CreateBackupParams { + p := &CreateBackupParams{} + p.p = make(map[string]interface{}) + p.p["virtualmachineid"] = virtualmachineid + return p +} + +// Create VM backup +func (s *BackupService) CreateBackup(p *CreateBackupParams) (*CreateBackupResponse, error) { + resp, err := s.cs.newPostRequest("createBackup", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateBackupResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type CreateBackupResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +type CreateBackupScheduleParams struct { + p map[string]interface{} +} + +func (p *CreateBackupScheduleParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["intervaltype"]; found { + u.Set("intervaltype", v.(string)) + } + if v, found := p.p["maxbackups"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("maxbackups", vv) + } + if v, found := p.p["quiescevm"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("quiescevm", vv) + } + if v, found := p.p["schedule"]; found { + u.Set("schedule", v.(string)) + } + if v, found := p.p["timezone"]; found { + u.Set("timezone", v.(string)) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + return u +} + +func (p *CreateBackupScheduleParams) SetIntervaltype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["intervaltype"] = v +} + +func (p *CreateBackupScheduleParams) ResetIntervaltype() { + if p.p != nil && p.p["intervaltype"] != nil { + delete(p.p, "intervaltype") + } +} + +func (p *CreateBackupScheduleParams) GetIntervaltype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["intervaltype"].(string) + return value, ok +} + +func (p *CreateBackupScheduleParams) SetMaxbackups(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxbackups"] = v +} + +func (p *CreateBackupScheduleParams) ResetMaxbackups() { + if p.p != nil && p.p["maxbackups"] != nil { + delete(p.p, "maxbackups") + } +} + +func (p *CreateBackupScheduleParams) GetMaxbackups() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxbackups"].(int) + return value, ok +} + +func (p *CreateBackupScheduleParams) SetQuiescevm(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["quiescevm"] = v +} + +func (p *CreateBackupScheduleParams) ResetQuiescevm() { + if p.p != nil && p.p["quiescevm"] != nil { + delete(p.p, "quiescevm") + } +} + +func (p *CreateBackupScheduleParams) GetQuiescevm() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["quiescevm"].(bool) + return value, ok +} + +func (p *CreateBackupScheduleParams) SetSchedule(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["schedule"] = v +} + +func (p *CreateBackupScheduleParams) ResetSchedule() { + if p.p != nil && p.p["schedule"] != nil { + delete(p.p, "schedule") + } +} + +func (p *CreateBackupScheduleParams) GetSchedule() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["schedule"].(string) + return value, ok +} + +func (p *CreateBackupScheduleParams) SetTimezone(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["timezone"] = v +} + +func (p *CreateBackupScheduleParams) ResetTimezone() { + if p.p != nil && p.p["timezone"] != nil { + delete(p.p, "timezone") + } +} + +func (p *CreateBackupScheduleParams) GetTimezone() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["timezone"].(string) + return value, ok +} + +func (p *CreateBackupScheduleParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *CreateBackupScheduleParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *CreateBackupScheduleParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +// You should always use this function to get a new CreateBackupScheduleParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewCreateBackupScheduleParams(intervaltype string, schedule string, timezone string, virtualmachineid string) *CreateBackupScheduleParams { + p := &CreateBackupScheduleParams{} + p.p = make(map[string]interface{}) + p.p["intervaltype"] = intervaltype + p.p["schedule"] = schedule + p.p["timezone"] = timezone + p.p["virtualmachineid"] = virtualmachineid + return p +} + +// Creates a user-defined VM backup schedule +func (s *BackupService) CreateBackupSchedule(p *CreateBackupScheduleParams) (*CreateBackupScheduleResponse, error) { + resp, err := s.cs.newPostRequest("createBackupSchedule", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateBackupScheduleResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type CreateBackupScheduleResponse struct { + Account string `json:"account"` + Accountid string `json:"accountid"` + Backupofferingid string `json:"backupofferingid"` + Backupofferingname string `json:"backupofferingname"` + Created string `json:"created"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Externalid string `json:"externalid"` + Id string `json:"id"` + Intervaltype string `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Size int64 `json:"size"` + Status string `json:"status"` + Type string `json:"type"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Virtualsize int64 `json:"virtualsize"` + Vmbackupofferingremoved bool `json:"vmbackupofferingremoved"` + Vmdetails map[string]string `json:"vmdetails"` + Volumes string `json:"volumes"` + Zone string `json:"zone"` + Zoneid string `json:"zoneid"` +} + +type CreateVMFromBackupParams struct { + p map[string]interface{} +} + +func (p *CreateVMFromBackupParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["affinitygroupids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("affinitygroupids", vv) + } + if v, found := p.p["affinitygroupnames"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("affinitygroupnames", vv) + } + if v, found := p.p["backupid"]; found { + u.Set("backupid", v.(string)) + } + if v, found := p.p["bootintosetup"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("bootintosetup", vv) + } + if v, found := p.p["bootmode"]; found { + u.Set("bootmode", v.(string)) + } + if v, found := p.p["boottype"]; found { + u.Set("boottype", v.(string)) + } + if v, found := p.p["clusterid"]; found { + u.Set("clusterid", v.(string)) + } + if v, found := p.p["copyimagetags"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("copyimagetags", vv) + } + if v, found := p.p["customid"]; found { + u.Set("customid", v.(string)) + } + if v, found := p.p["datadiskofferinglist"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("datadiskofferinglist[%d].disk", i), k) + u.Set(fmt.Sprintf("datadiskofferinglist[%d].diskOffering", i), m[k]) + } + } + if v, found := p.p["datadisksdetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("datadisksdetails[%d].key", i), k) + u.Set(fmt.Sprintf("datadisksdetails[%d].value", i), m[k]) + } + } + if v, found := p.p["deploymentplanner"]; found { + u.Set("deploymentplanner", v.(string)) + } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } + if v, found := p.p["dhcpoptionsnetworklist"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("dhcpoptionsnetworklist[%d].key", i), k) + u.Set(fmt.Sprintf("dhcpoptionsnetworklist[%d].value", i), m[k]) + } + } + if v, found := p.p["diskofferingid"]; found { + u.Set("diskofferingid", v.(string)) + } + if v, found := p.p["displayname"]; found { + u.Set("displayname", v.(string)) + } + if v, found := p.p["displayvm"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("displayvm", vv) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["dynamicscalingenabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("dynamicscalingenabled", vv) + } + if v, found := p.p["externaldetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("externaldetails[%d].key", i), k) + u.Set(fmt.Sprintf("externaldetails[%d].value", i), m[k]) + } + } + if v, found := p.p["extraconfig"]; found { + u.Set("extraconfig", v.(string)) + } + if v, found := p.p["group"]; found { + u.Set("group", v.(string)) + } + if v, found := p.p["hostid"]; found { + u.Set("hostid", v.(string)) + } + if v, found := p.p["hypervisor"]; found { + u.Set("hypervisor", v.(string)) + } + if v, found := p.p["iodriverpolicy"]; found { + u.Set("iodriverpolicy", v.(string)) + } + if v, found := p.p["iothreadsenabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("iothreadsenabled", vv) + } + if v, found := p.p["ip6address"]; found { + u.Set("ip6address", v.(string)) + } + if v, found := p.p["ipaddress"]; found { + u.Set("ipaddress", v.(string)) + } + if v, found := p.p["iptonetworklist"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("iptonetworklist[%d].key", i), k) + u.Set(fmt.Sprintf("iptonetworklist[%d].value", i), m[k]) + } + } + if v, found := p.p["keyboard"]; found { + u.Set("keyboard", v.(string)) + } + if v, found := p.p["keypair"]; found { + u.Set("keypair", v.(string)) + } + if v, found := p.p["keypairs"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("keypairs", vv) + } + if v, found := p.p["leaseduration"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("leaseduration", vv) + } + if v, found := p.p["leaseexpiryaction"]; found { + u.Set("leaseexpiryaction", v.(string)) + } + if v, found := p.p["macaddress"]; found { + u.Set("macaddress", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["networkids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("networkids", vv) + } + if v, found := p.p["nicmultiqueuenumber"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("nicmultiqueuenumber", vv) + } + if v, found := p.p["nicnetworklist"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("nicnetworklist[%d].nic", i), k) + u.Set(fmt.Sprintf("nicnetworklist[%d].network", i), m[k]) + } + } + if v, found := p.p["nicpackedvirtqueuesenabled"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("nicpackedvirtqueuesenabled", vv) + } + if v, found := p.p["overridediskofferingid"]; found { + u.Set("overridediskofferingid", v.(string)) + } + if v, found := p.p["password"]; found { + u.Set("password", v.(string)) + } + if v, found := p.p["podid"]; found { + u.Set("podid", v.(string)) + } + if v, found := p.p["preserveip"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("preserveip", vv) + } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } + if v, found := p.p["properties"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("properties[%d].key", i), k) + u.Set(fmt.Sprintf("properties[%d].value", i), m[k]) + } + } + if v, found := p.p["rootdisksize"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("rootdisksize", vv) + } + if v, found := p.p["securitygroupids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("securitygroupids", vv) + } + if v, found := p.p["securitygroupnames"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("securitygroupnames", vv) + } + if v, found := p.p["serviceofferingid"]; found { + u.Set("serviceofferingid", v.(string)) + } + if v, found := p.p["size"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("size", vv) + } + if v, found := p.p["startvm"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("startvm", vv) + } + if v, found := p.p["templateid"]; found { + u.Set("templateid", v.(string)) + } + if v, found := p.p["userdata"]; found { + u.Set("userdata", v.(string)) + } + if v, found := p.p["userdatadetails"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("userdatadetails[%d].key", i), k) + u.Set(fmt.Sprintf("userdatadetails[%d].value", i), m[k]) + } + } + if v, found := p.p["userdataid"]; found { + u.Set("userdataid", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *CreateVMFromBackupParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *CreateVMFromBackupParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *CreateVMFromBackupParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetAffinitygroupids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["affinitygroupids"] = v +} + +func (p *CreateVMFromBackupParams) ResetAffinitygroupids() { + if p.p != nil && p.p["affinitygroupids"] != nil { + delete(p.p, "affinitygroupids") + } +} + +func (p *CreateVMFromBackupParams) GetAffinitygroupids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["affinitygroupids"].([]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetAffinitygroupnames(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["affinitygroupnames"] = v +} + +func (p *CreateVMFromBackupParams) ResetAffinitygroupnames() { + if p.p != nil && p.p["affinitygroupnames"] != nil { + delete(p.p, "affinitygroupnames") + } +} + +func (p *CreateVMFromBackupParams) GetAffinitygroupnames() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["affinitygroupnames"].([]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetBackupid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["backupid"] = v +} + +func (p *CreateVMFromBackupParams) ResetBackupid() { + if p.p != nil && p.p["backupid"] != nil { + delete(p.p, "backupid") + } +} + +func (p *CreateVMFromBackupParams) GetBackupid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["backupid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetBootintosetup(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["bootintosetup"] = v +} + +func (p *CreateVMFromBackupParams) ResetBootintosetup() { + if p.p != nil && p.p["bootintosetup"] != nil { + delete(p.p, "bootintosetup") + } +} + +func (p *CreateVMFromBackupParams) GetBootintosetup() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["bootintosetup"].(bool) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetBootmode(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["bootmode"] = v +} + +func (p *CreateVMFromBackupParams) ResetBootmode() { + if p.p != nil && p.p["bootmode"] != nil { + delete(p.p, "bootmode") + } +} + +func (p *CreateVMFromBackupParams) GetBootmode() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["bootmode"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetBoottype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["boottype"] = v +} + +func (p *CreateVMFromBackupParams) ResetBoottype() { + if p.p != nil && p.p["boottype"] != nil { + delete(p.p, "boottype") + } +} + +func (p *CreateVMFromBackupParams) GetBoottype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["boottype"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetClusterid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["clusterid"] = v +} + +func (p *CreateVMFromBackupParams) ResetClusterid() { + if p.p != nil && p.p["clusterid"] != nil { + delete(p.p, "clusterid") + } +} + +func (p *CreateVMFromBackupParams) GetClusterid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["clusterid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetCopyimagetags(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["copyimagetags"] = v +} + +func (p *CreateVMFromBackupParams) ResetCopyimagetags() { + if p.p != nil && p.p["copyimagetags"] != nil { + delete(p.p, "copyimagetags") + } +} + +func (p *CreateVMFromBackupParams) GetCopyimagetags() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["copyimagetags"].(bool) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetCustomid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["customid"] = v +} + +func (p *CreateVMFromBackupParams) ResetCustomid() { + if p.p != nil && p.p["customid"] != nil { + delete(p.p, "customid") + } +} + +func (p *CreateVMFromBackupParams) GetCustomid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["customid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDatadiskofferinglist(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["datadiskofferinglist"] = v +} + +func (p *CreateVMFromBackupParams) ResetDatadiskofferinglist() { + if p.p != nil && p.p["datadiskofferinglist"] != nil { + delete(p.p, "datadiskofferinglist") + } +} + +func (p *CreateVMFromBackupParams) GetDatadiskofferinglist() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["datadiskofferinglist"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDatadisksdetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["datadisksdetails"] = v +} + +func (p *CreateVMFromBackupParams) ResetDatadisksdetails() { + if p.p != nil && p.p["datadisksdetails"] != nil { + delete(p.p, "datadisksdetails") + } +} + +func (p *CreateVMFromBackupParams) GetDatadisksdetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["datadisksdetails"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDeploymentplanner(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["deploymentplanner"] = v +} + +func (p *CreateVMFromBackupParams) ResetDeploymentplanner() { + if p.p != nil && p.p["deploymentplanner"] != nil { + delete(p.p, "deploymentplanner") + } +} + +func (p *CreateVMFromBackupParams) GetDeploymentplanner() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["deploymentplanner"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *CreateVMFromBackupParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *CreateVMFromBackupParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDhcpoptionsnetworklist(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["dhcpoptionsnetworklist"] = v +} + +func (p *CreateVMFromBackupParams) ResetDhcpoptionsnetworklist() { + if p.p != nil && p.p["dhcpoptionsnetworklist"] != nil { + delete(p.p, "dhcpoptionsnetworklist") + } +} + +func (p *CreateVMFromBackupParams) GetDhcpoptionsnetworklist() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["dhcpoptionsnetworklist"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDiskofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["diskofferingid"] = v +} + +func (p *CreateVMFromBackupParams) ResetDiskofferingid() { + if p.p != nil && p.p["diskofferingid"] != nil { + delete(p.p, "diskofferingid") + } +} + +func (p *CreateVMFromBackupParams) GetDiskofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["diskofferingid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDisplayname(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["displayname"] = v +} + +func (p *CreateVMFromBackupParams) ResetDisplayname() { + if p.p != nil && p.p["displayname"] != nil { + delete(p.p, "displayname") + } +} + +func (p *CreateVMFromBackupParams) GetDisplayname() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["displayname"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDisplayvm(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["displayvm"] = v +} + +func (p *CreateVMFromBackupParams) ResetDisplayvm() { + if p.p != nil && p.p["displayvm"] != nil { + delete(p.p, "displayvm") + } +} + +func (p *CreateVMFromBackupParams) GetDisplayvm() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["displayvm"].(bool) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *CreateVMFromBackupParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *CreateVMFromBackupParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetDynamicscalingenabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["dynamicscalingenabled"] = v +} + +func (p *CreateVMFromBackupParams) ResetDynamicscalingenabled() { + if p.p != nil && p.p["dynamicscalingenabled"] != nil { + delete(p.p, "dynamicscalingenabled") + } +} + +func (p *CreateVMFromBackupParams) GetDynamicscalingenabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["dynamicscalingenabled"].(bool) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetExternaldetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externaldetails"] = v +} + +func (p *CreateVMFromBackupParams) ResetExternaldetails() { + if p.p != nil && p.p["externaldetails"] != nil { + delete(p.p, "externaldetails") + } +} + +func (p *CreateVMFromBackupParams) GetExternaldetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externaldetails"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetExtraconfig(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extraconfig"] = v +} + +func (p *CreateVMFromBackupParams) ResetExtraconfig() { + if p.p != nil && p.p["extraconfig"] != nil { + delete(p.p, "extraconfig") + } +} + +func (p *CreateVMFromBackupParams) GetExtraconfig() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extraconfig"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetGroup(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["group"] = v +} + +func (p *CreateVMFromBackupParams) ResetGroup() { + if p.p != nil && p.p["group"] != nil { + delete(p.p, "group") + } +} + +func (p *CreateVMFromBackupParams) GetGroup() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["group"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetHostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hostid"] = v +} + +func (p *CreateVMFromBackupParams) ResetHostid() { + if p.p != nil && p.p["hostid"] != nil { + delete(p.p, "hostid") + } +} + +func (p *CreateVMFromBackupParams) GetHostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hostid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetHypervisor(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hypervisor"] = v +} + +func (p *CreateVMFromBackupParams) ResetHypervisor() { + if p.p != nil && p.p["hypervisor"] != nil { + delete(p.p, "hypervisor") + } +} + +func (p *CreateVMFromBackupParams) GetHypervisor() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hypervisor"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetIodriverpolicy(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["iodriverpolicy"] = v +} + +func (p *CreateVMFromBackupParams) ResetIodriverpolicy() { + if p.p != nil && p.p["iodriverpolicy"] != nil { + delete(p.p, "iodriverpolicy") + } +} + +func (p *CreateVMFromBackupParams) GetIodriverpolicy() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["iodriverpolicy"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetIothreadsenabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["iothreadsenabled"] = v +} + +func (p *CreateVMFromBackupParams) ResetIothreadsenabled() { + if p.p != nil && p.p["iothreadsenabled"] != nil { + delete(p.p, "iothreadsenabled") + } +} + +func (p *CreateVMFromBackupParams) GetIothreadsenabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["iothreadsenabled"].(bool) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetIp6address(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ip6address"] = v +} + +func (p *CreateVMFromBackupParams) ResetIp6address() { + if p.p != nil && p.p["ip6address"] != nil { + delete(p.p, "ip6address") + } +} + +func (p *CreateVMFromBackupParams) GetIp6address() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ip6address"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetIpaddress(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ipaddress"] = v +} + +func (p *CreateVMFromBackupParams) ResetIpaddress() { + if p.p != nil && p.p["ipaddress"] != nil { + delete(p.p, "ipaddress") + } +} + +func (p *CreateVMFromBackupParams) GetIpaddress() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ipaddress"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetIptonetworklist(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["iptonetworklist"] = v +} + +func (p *CreateVMFromBackupParams) ResetIptonetworklist() { + if p.p != nil && p.p["iptonetworklist"] != nil { + delete(p.p, "iptonetworklist") + } +} + +func (p *CreateVMFromBackupParams) GetIptonetworklist() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["iptonetworklist"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetKeyboard(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyboard"] = v +} + +func (p *CreateVMFromBackupParams) ResetKeyboard() { + if p.p != nil && p.p["keyboard"] != nil { + delete(p.p, "keyboard") + } +} + +func (p *CreateVMFromBackupParams) GetKeyboard() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyboard"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetKeypair(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keypair"] = v +} + +func (p *CreateVMFromBackupParams) ResetKeypair() { + if p.p != nil && p.p["keypair"] != nil { + delete(p.p, "keypair") + } +} + +func (p *CreateVMFromBackupParams) GetKeypair() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keypair"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetKeypairs(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keypairs"] = v +} + +func (p *CreateVMFromBackupParams) ResetKeypairs() { + if p.p != nil && p.p["keypairs"] != nil { + delete(p.p, "keypairs") + } +} + +func (p *CreateVMFromBackupParams) GetKeypairs() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keypairs"].([]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetLeaseduration(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseduration"] = v +} + +func (p *CreateVMFromBackupParams) ResetLeaseduration() { + if p.p != nil && p.p["leaseduration"] != nil { + delete(p.p, "leaseduration") + } +} + +func (p *CreateVMFromBackupParams) GetLeaseduration() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseduration"].(int) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetLeaseexpiryaction(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["leaseexpiryaction"] = v +} + +func (p *CreateVMFromBackupParams) ResetLeaseexpiryaction() { + if p.p != nil && p.p["leaseexpiryaction"] != nil { + delete(p.p, "leaseexpiryaction") + } +} + +func (p *CreateVMFromBackupParams) GetLeaseexpiryaction() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["leaseexpiryaction"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetMacaddress(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["macaddress"] = v +} + +func (p *CreateVMFromBackupParams) ResetMacaddress() { + if p.p != nil && p.p["macaddress"] != nil { + delete(p.p, "macaddress") + } +} + +func (p *CreateVMFromBackupParams) GetMacaddress() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["macaddress"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *CreateVMFromBackupParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *CreateVMFromBackupParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetNetworkids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkids"] = v +} + +func (p *CreateVMFromBackupParams) ResetNetworkids() { + if p.p != nil && p.p["networkids"] != nil { + delete(p.p, "networkids") + } +} + +func (p *CreateVMFromBackupParams) GetNetworkids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkids"].([]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetNicmultiqueuenumber(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nicmultiqueuenumber"] = v +} + +func (p *CreateVMFromBackupParams) ResetNicmultiqueuenumber() { + if p.p != nil && p.p["nicmultiqueuenumber"] != nil { + delete(p.p, "nicmultiqueuenumber") + } +} + +func (p *CreateVMFromBackupParams) GetNicmultiqueuenumber() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nicmultiqueuenumber"].(int) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetNicnetworklist(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nicnetworklist"] = v +} + +func (p *CreateVMFromBackupParams) ResetNicnetworklist() { + if p.p != nil && p.p["nicnetworklist"] != nil { + delete(p.p, "nicnetworklist") + } +} + +func (p *CreateVMFromBackupParams) GetNicnetworklist() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nicnetworklist"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetNicpackedvirtqueuesenabled(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nicpackedvirtqueuesenabled"] = v +} + +func (p *CreateVMFromBackupParams) ResetNicpackedvirtqueuesenabled() { + if p.p != nil && p.p["nicpackedvirtqueuesenabled"] != nil { + delete(p.p, "nicpackedvirtqueuesenabled") + } +} + +func (p *CreateVMFromBackupParams) GetNicpackedvirtqueuesenabled() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nicpackedvirtqueuesenabled"].(bool) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetOverridediskofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["overridediskofferingid"] = v +} + +func (p *CreateVMFromBackupParams) ResetOverridediskofferingid() { + if p.p != nil && p.p["overridediskofferingid"] != nil { + delete(p.p, "overridediskofferingid") + } +} + +func (p *CreateVMFromBackupParams) GetOverridediskofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["overridediskofferingid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetPassword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["password"] = v +} + +func (p *CreateVMFromBackupParams) ResetPassword() { + if p.p != nil && p.p["password"] != nil { + delete(p.p, "password") + } +} + +func (p *CreateVMFromBackupParams) GetPassword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["password"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetPodid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["podid"] = v +} + +func (p *CreateVMFromBackupParams) ResetPodid() { + if p.p != nil && p.p["podid"] != nil { + delete(p.p, "podid") + } +} + +func (p *CreateVMFromBackupParams) GetPodid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["podid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetPreserveip(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["preserveip"] = v +} + +func (p *CreateVMFromBackupParams) ResetPreserveip() { + if p.p != nil && p.p["preserveip"] != nil { + delete(p.p, "preserveip") + } +} + +func (p *CreateVMFromBackupParams) GetPreserveip() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["preserveip"].(bool) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *CreateVMFromBackupParams) ResetProjectid() { + if p.p != nil && p.p["projectid"] != nil { + delete(p.p, "projectid") + } +} + +func (p *CreateVMFromBackupParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetProperties(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["properties"] = v +} + +func (p *CreateVMFromBackupParams) ResetProperties() { + if p.p != nil && p.p["properties"] != nil { + delete(p.p, "properties") + } +} + +func (p *CreateVMFromBackupParams) GetProperties() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["properties"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetRootdisksize(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["rootdisksize"] = v +} + +func (p *CreateVMFromBackupParams) ResetRootdisksize() { + if p.p != nil && p.p["rootdisksize"] != nil { + delete(p.p, "rootdisksize") + } +} + +func (p *CreateVMFromBackupParams) GetRootdisksize() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["rootdisksize"].(int64) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetSecuritygroupids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["securitygroupids"] = v +} + +func (p *CreateVMFromBackupParams) ResetSecuritygroupids() { + if p.p != nil && p.p["securitygroupids"] != nil { + delete(p.p, "securitygroupids") + } +} + +func (p *CreateVMFromBackupParams) GetSecuritygroupids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["securitygroupids"].([]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetSecuritygroupnames(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["securitygroupnames"] = v +} + +func (p *CreateVMFromBackupParams) ResetSecuritygroupnames() { + if p.p != nil && p.p["securitygroupnames"] != nil { + delete(p.p, "securitygroupnames") + } +} + +func (p *CreateVMFromBackupParams) GetSecuritygroupnames() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["securitygroupnames"].([]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetServiceofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["serviceofferingid"] = v +} + +func (p *CreateVMFromBackupParams) ResetServiceofferingid() { + if p.p != nil && p.p["serviceofferingid"] != nil { + delete(p.p, "serviceofferingid") + } +} + +func (p *CreateVMFromBackupParams) GetServiceofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["serviceofferingid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetSize(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["size"] = v +} + +func (p *CreateVMFromBackupParams) ResetSize() { + if p.p != nil && p.p["size"] != nil { + delete(p.p, "size") + } +} + +func (p *CreateVMFromBackupParams) GetSize() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["size"].(int64) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetStartvm(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startvm"] = v +} + +func (p *CreateVMFromBackupParams) ResetStartvm() { + if p.p != nil && p.p["startvm"] != nil { + delete(p.p, "startvm") + } +} + +func (p *CreateVMFromBackupParams) GetStartvm() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startvm"].(bool) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetTemplateid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["templateid"] = v +} + +func (p *CreateVMFromBackupParams) ResetTemplateid() { + if p.p != nil && p.p["templateid"] != nil { + delete(p.p, "templateid") + } +} + +func (p *CreateVMFromBackupParams) GetTemplateid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["templateid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetUserdata(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdata"] = v +} + +func (p *CreateVMFromBackupParams) ResetUserdata() { + if p.p != nil && p.p["userdata"] != nil { + delete(p.p, "userdata") + } +} + +func (p *CreateVMFromBackupParams) GetUserdata() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdata"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetUserdatadetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdatadetails"] = v +} + +func (p *CreateVMFromBackupParams) ResetUserdatadetails() { + if p.p != nil && p.p["userdatadetails"] != nil { + delete(p.p, "userdatadetails") + } +} + +func (p *CreateVMFromBackupParams) GetUserdatadetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdatadetails"].(map[string]string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetUserdataid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["userdataid"] = v +} + +func (p *CreateVMFromBackupParams) ResetUserdataid() { + if p.p != nil && p.p["userdataid"] != nil { + delete(p.p, "userdataid") + } +} + +func (p *CreateVMFromBackupParams) GetUserdataid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["userdataid"].(string) + return value, ok +} + +func (p *CreateVMFromBackupParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *CreateVMFromBackupParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *CreateVMFromBackupParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new CreateVMFromBackupParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewCreateVMFromBackupParams(backupid string, zoneid string) *CreateVMFromBackupParams { + p := &CreateVMFromBackupParams{} + p.p = make(map[string]interface{}) + p.p["backupid"] = backupid + p.p["zoneid"] = zoneid + return p +} + +// Creates and automatically starts a VM from a backup. +func (s *BackupService) CreateVMFromBackup(p *CreateVMFromBackupParams) (*CreateVMFromBackupResponse, error) { + resp, err := s.cs.newPostRequest("createVMFromBackup", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateVMFromBackupResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type CreateVMFromBackupResponse struct { + Account string `json:"account"` + Affinitygroup []CreateVMFromBackupResponseAffinitygroup `json:"affinitygroup"` + Arch string `json:"arch"` + Autoscalevmgroupid string `json:"autoscalevmgroupid"` + Autoscalevmgroupname string `json:"autoscalevmgroupname"` + Backupofferingid string `json:"backupofferingid"` + Backupofferingname string `json:"backupofferingname"` + Bootmode string `json:"bootmode"` + Boottype string `json:"boottype"` + Cpunumber int `json:"cpunumber"` + Cpuspeed int `json:"cpuspeed"` + Cpuused string `json:"cpuused"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Details map[string]string `json:"details"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayname string `json:"displayname"` + Displayvm bool `json:"displayvm"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Forvirtualnetwork bool `json:"forvirtualnetwork"` + Gpucardid string `json:"gpucardid"` + Gpucardname string `json:"gpucardname"` + Gpucount int `json:"gpucount"` + Group string `json:"group"` + Groupid string `json:"groupid"` + Guestosid string `json:"guestosid"` + Haenable bool `json:"haenable"` + Hasannotations bool `json:"hasannotations"` + Hostcontrolstate string `json:"hostcontrolstate"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + Hypervisor string `json:"hypervisor"` + Icon interface{} `json:"icon"` + Id string `json:"id"` + Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` + Isdynamicallyscalable bool `json:"isdynamicallyscalable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Keypairs string `json:"keypairs"` + Lastupdated string `json:"lastupdated"` + Leaseduration int `json:"leaseduration"` + Leaseexpiryaction string `json:"leaseexpiryaction"` + Leaseexpirydate string `json:"leaseexpirydate"` + Maxheads int64 `json:"maxheads"` + Maxresolutionx int64 `json:"maxresolutionx"` + Maxresolutiony int64 `json:"maxresolutiony"` + Memory int `json:"memory"` + Memoryintfreekbs int64 `json:"memoryintfreekbs"` + Memorykbs int64 `json:"memorykbs"` + Memorytargetkbs int64 `json:"memorytargetkbs"` + Name string `json:"name"` + Networkkbsread int64 `json:"networkkbsread"` + Networkkbswrite int64 `json:"networkkbswrite"` + Nic []Nic `json:"nic"` + Osdisplayname string `json:"osdisplayname"` + Ostypeid string `json:"ostypeid"` + Password string `json:"password"` + Passwordenabled bool `json:"passwordenabled"` + Pooltype string `json:"pooltype"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Publicip string `json:"publicip"` + Publicipid string `json:"publicipid"` + Readonlydetails string `json:"readonlydetails"` + Receivedbytes int64 `json:"receivedbytes"` + Rootdeviceid int64 `json:"rootdeviceid"` + Rootdevicetype string `json:"rootdevicetype"` + Securitygroup []CreateVMFromBackupResponseSecuritygroup `json:"securitygroup"` + Sentbytes int64 `json:"sentbytes"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Servicestate string `json:"servicestate"` + State string `json:"state"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Templatetype string `json:"templatetype"` + Userdata string `json:"userdata"` + Userdatadetails string `json:"userdatadetails"` + Userdataid string `json:"userdataid"` + Userdataname string `json:"userdataname"` + Userdatapolicy string `json:"userdatapolicy"` + Userid string `json:"userid"` + Username string `json:"username"` + Vgpu string `json:"vgpu"` + Vgpuprofileid string `json:"vgpuprofileid"` + Vgpuprofilename string `json:"vgpuprofilename"` + Videoram int64 `json:"videoram"` + Vmtype string `json:"vmtype"` + Vnfdetails map[string]string `json:"vnfdetails"` + Vnfnics []string `json:"vnfnics"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type CreateVMFromBackupResponseSecuritygroup struct { + Account string `json:"account"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Egressrule []CreateVMFromBackupResponseSecuritygroupRule `json:"egressrule"` + Id string `json:"id"` + Ingressrule []CreateVMFromBackupResponseSecuritygroupRule `json:"ingressrule"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Tags []Tags `json:"tags"` + Virtualmachinecount int `json:"virtualmachinecount"` + Virtualmachineids []interface{} `json:"virtualmachineids"` +} + +type CreateVMFromBackupResponseSecuritygroupRule struct { + Account string `json:"account"` + Cidr string `json:"cidr"` + Endport int `json:"endport"` + Icmpcode int `json:"icmpcode"` + Icmptype int `json:"icmptype"` + Protocol string `json:"protocol"` + Ruleid string `json:"ruleid"` + Securitygroupname string `json:"securitygroupname"` + Startport int `json:"startport"` + Tags []Tags `json:"tags"` +} + +type CreateVMFromBackupResponseAffinitygroup struct { + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` +} + +func (r *CreateVMFromBackupResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias CreateVMFromBackupResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type DeleteBackupParams struct { + p map[string]interface{} +} + +func (p *DeleteBackupParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["forced"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forced", vv) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteBackupParams) SetForced(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forced"] = v +} + +func (p *DeleteBackupParams) ResetForced() { + if p.p != nil && p.p["forced"] != nil { + delete(p.p, "forced") + } +} + +func (p *DeleteBackupParams) GetForced() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forced"].(bool) + return value, ok +} + +func (p *DeleteBackupParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteBackupParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteBackupParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteBackupParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewDeleteBackupParams(id string) *DeleteBackupParams { + p := &DeleteBackupParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Delete VM backup +func (s *BackupService) DeleteBackup(p *DeleteBackupParams) (*DeleteBackupResponse, error) { + resp, err := s.cs.newPostRequest("deleteBackup", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteBackupResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type DeleteBackupResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +type DeleteBackupOfferingParams struct { + p map[string]interface{} +} + +func (p *DeleteBackupOfferingParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteBackupOfferingParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteBackupOfferingParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteBackupOfferingParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteBackupOfferingParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewDeleteBackupOfferingParams(id string) *DeleteBackupOfferingParams { + p := &DeleteBackupOfferingParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Deletes a backup offering +func (s *BackupService) DeleteBackupOffering(p *DeleteBackupOfferingParams) (*DeleteBackupOfferingResponse, error) { + resp, err := s.cs.newPostRequest("deleteBackupOffering", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteBackupOfferingResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteBackupOfferingResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *DeleteBackupOfferingResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias DeleteBackupOfferingResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type DeleteBackupRepositoryParams struct { + p map[string]interface{} +} + +func (p *DeleteBackupRepositoryParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteBackupRepositoryParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteBackupRepositoryParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteBackupRepositoryParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteBackupRepositoryParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewDeleteBackupRepositoryParams(id string) *DeleteBackupRepositoryParams { + p := &DeleteBackupRepositoryParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// delete a backup repository +func (s *BackupService) DeleteBackupRepository(p *DeleteBackupRepositoryParams) (*DeleteBackupRepositoryResponse, error) { + resp, err := s.cs.newPostRequest("deleteBackupRepository", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteBackupRepositoryResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteBackupRepositoryResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *DeleteBackupRepositoryResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias DeleteBackupRepositoryResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type DeleteBackupScheduleParams struct { + p map[string]interface{} +} + +func (p *DeleteBackupScheduleParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + return u +} + +func (p *DeleteBackupScheduleParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteBackupScheduleParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteBackupScheduleParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *DeleteBackupScheduleParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *DeleteBackupScheduleParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *DeleteBackupScheduleParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteBackupScheduleParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewDeleteBackupScheduleParams() *DeleteBackupScheduleParams { + p := &DeleteBackupScheduleParams{} + p.p = make(map[string]interface{}) + return p +} + +// Deletes the backup schedule of a VM +func (s *BackupService) DeleteBackupSchedule(p *DeleteBackupScheduleParams) (*DeleteBackupScheduleResponse, error) { + resp, err := s.cs.newPostRequest("deleteBackupSchedule", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteBackupScheduleResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type DeleteBackupScheduleResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *DeleteBackupScheduleResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias DeleteBackupScheduleResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type ImportBackupOfferingParams struct { + p map[string]interface{} +} + +func (p *ImportBackupOfferingParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["allowuserdrivenbackups"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("allowuserdrivenbackups", vv) + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["externalid"]; found { + u.Set("externalid", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ImportBackupOfferingParams) SetAllowuserdrivenbackups(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["allowuserdrivenbackups"] = v +} + +func (p *ImportBackupOfferingParams) ResetAllowuserdrivenbackups() { + if p.p != nil && p.p["allowuserdrivenbackups"] != nil { + delete(p.p, "allowuserdrivenbackups") + } +} + +func (p *ImportBackupOfferingParams) GetAllowuserdrivenbackups() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["allowuserdrivenbackups"].(bool) + return value, ok +} + +func (p *ImportBackupOfferingParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *ImportBackupOfferingParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *ImportBackupOfferingParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *ImportBackupOfferingParams) SetExternalid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["externalid"] = v +} + +func (p *ImportBackupOfferingParams) ResetExternalid() { + if p.p != nil && p.p["externalid"] != nil { + delete(p.p, "externalid") + } +} + +func (p *ImportBackupOfferingParams) GetExternalid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["externalid"].(string) + return value, ok +} + +func (p *ImportBackupOfferingParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ImportBackupOfferingParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ImportBackupOfferingParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ImportBackupOfferingParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ImportBackupOfferingParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ImportBackupOfferingParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new ImportBackupOfferingParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewImportBackupOfferingParams(allowuserdrivenbackups bool, description string, externalid string, name string, zoneid string) *ImportBackupOfferingParams { + p := &ImportBackupOfferingParams{} + p.p = make(map[string]interface{}) + p.p["allowuserdrivenbackups"] = allowuserdrivenbackups + p.p["description"] = description + p.p["externalid"] = externalid + p.p["name"] = name + p.p["zoneid"] = zoneid + return p +} + +// Imports a backup offering using a backup provider +func (s *BackupService) ImportBackupOffering(p *ImportBackupOfferingParams) (*ImportBackupOfferingResponse, error) { + resp, err := s.cs.newPostRequest("importBackupOffering", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ImportBackupOfferingResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type ImportBackupOfferingResponse struct { + Allowuserdrivenbackups bool `json:"allowuserdrivenbackups"` + Created string `json:"created"` + Description string `json:"description"` + Externalid string `json:"externalid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Provider string `json:"provider"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type ListBackupOfferingsParams struct { + p map[string]interface{} +} + +func (p *ListBackupOfferingsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListBackupOfferingsParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListBackupOfferingsParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListBackupOfferingsParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListBackupOfferingsParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListBackupOfferingsParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListBackupOfferingsParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListBackupOfferingsParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListBackupOfferingsParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListBackupOfferingsParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListBackupOfferingsParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListBackupOfferingsParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListBackupOfferingsParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListBackupOfferingsParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListBackupOfferingsParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ListBackupOfferingsParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new ListBackupOfferingsParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewListBackupOfferingsParams() *ListBackupOfferingsParams { + p := &ListBackupOfferingsParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupOfferingID(keyword string, opts ...OptionFunc) (string, int, error) { + p := &ListBackupOfferingsParams{} + p.p = make(map[string]interface{}) + + p.p["keyword"] = keyword + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListBackupOfferings(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", keyword, l) + } + + if l.Count == 1 { + return l.BackupOfferings[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.BackupOfferings { + if v.Name == keyword { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupOfferingByName(name string, opts ...OptionFunc) (*BackupOffering, int, error) { + id, count, err := s.GetBackupOfferingID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetBackupOfferingByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupOfferingByID(id string, opts ...OptionFunc) (*BackupOffering, int, error) { + p := &ListBackupOfferingsParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListBackupOfferings(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.BackupOfferings[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for BackupOffering UUID: %s!", id) +} + +// Lists backup offerings +func (s *BackupService) ListBackupOfferings(p *ListBackupOfferingsParams) (*ListBackupOfferingsResponse, error) { + resp, err := s.cs.newRequest("listBackupOfferings", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListBackupOfferingsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListBackupOfferingsResponse struct { + Count int `json:"count"` + BackupOfferings []*BackupOffering `json:"backupoffering"` +} + +type BackupOffering struct { + Allowuserdrivenbackups bool `json:"allowuserdrivenbackups"` + Created string `json:"created"` + Description string `json:"description"` + Externalid string `json:"externalid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Provider string `json:"provider"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type ListBackupProviderOfferingsParams struct { + p map[string]interface{} +} + +func (p *ListBackupProviderOfferingsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListBackupProviderOfferingsParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListBackupProviderOfferingsParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListBackupProviderOfferingsParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListBackupProviderOfferingsParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListBackupProviderOfferingsParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListBackupProviderOfferingsParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListBackupProviderOfferingsParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListBackupProviderOfferingsParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListBackupProviderOfferingsParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListBackupProviderOfferingsParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListBackupProviderOfferingsParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ListBackupProviderOfferingsParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new ListBackupProviderOfferingsParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewListBackupProviderOfferingsParams(zoneid string) *ListBackupProviderOfferingsParams { + p := &ListBackupProviderOfferingsParams{} + p.p = make(map[string]interface{}) + p.p["zoneid"] = zoneid + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupProviderOfferingID(keyword string, zoneid string, opts ...OptionFunc) (string, int, error) { + p := &ListBackupProviderOfferingsParams{} + p.p = make(map[string]interface{}) + + p.p["keyword"] = keyword + p.p["zoneid"] = zoneid + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListBackupProviderOfferings(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", keyword, l) + } + + if l.Count == 1 { + return l.BackupProviderOfferings[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.BackupProviderOfferings { + if v.Name == keyword { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) +} + +// Lists external backup offerings of the provider +func (s *BackupService) ListBackupProviderOfferings(p *ListBackupProviderOfferingsParams) (*ListBackupProviderOfferingsResponse, error) { + resp, err := s.cs.newRequest("listBackupProviderOfferings", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListBackupProviderOfferingsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListBackupProviderOfferingsResponse struct { + Count int `json:"count"` + BackupProviderOfferings []*BackupProviderOffering `json:"backupprovideroffering"` +} + +type BackupProviderOffering struct { + Allowuserdrivenbackups bool `json:"allowuserdrivenbackups"` + Created string `json:"created"` + Description string `json:"description"` + Externalid string `json:"externalid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Provider string `json:"provider"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type ListBackupProvidersParams struct { + p map[string]interface{} +} + +func (p *ListBackupProvidersParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + return u +} + +func (p *ListBackupProvidersParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListBackupProvidersParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ListBackupProvidersParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +// You should always use this function to get a new ListBackupProvidersParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewListBackupProvidersParams() *ListBackupProvidersParams { + p := &ListBackupProvidersParams{} + p.p = make(map[string]interface{}) + return p +} + +// Lists Backup and Recovery providers +func (s *BackupService) ListBackupProviders(p *ListBackupProvidersParams) (*ListBackupProvidersResponse, error) { + resp, err := s.cs.newRequest("listBackupProviders", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListBackupProvidersResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListBackupProvidersResponse struct { + Count int `json:"count"` + BackupProviders []*BackupProvider `json:"backupprovider"` +} + +type BackupProvider struct { + Description string `json:"description"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` +} + +type ListBackupRepositoriesParams struct { + p map[string]interface{} +} + +func (p *ListBackupRepositoriesParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["provider"]; found { + u.Set("provider", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListBackupRepositoriesParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListBackupRepositoriesParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListBackupRepositoriesParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListBackupRepositoriesParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListBackupRepositoriesParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListBackupRepositoriesParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListBackupRepositoriesParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListBackupRepositoriesParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ListBackupRepositoriesParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ListBackupRepositoriesParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListBackupRepositoriesParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListBackupRepositoriesParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListBackupRepositoriesParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListBackupRepositoriesParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListBackupRepositoriesParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListBackupRepositoriesParams) SetProvider(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["provider"] = v +} + +func (p *ListBackupRepositoriesParams) ResetProvider() { + if p.p != nil && p.p["provider"] != nil { + delete(p.p, "provider") + } +} + +func (p *ListBackupRepositoriesParams) GetProvider() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["provider"].(string) + return value, ok +} + +func (p *ListBackupRepositoriesParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListBackupRepositoriesParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ListBackupRepositoriesParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new ListBackupRepositoriesParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewListBackupRepositoriesParams() *ListBackupRepositoriesParams { + p := &ListBackupRepositoriesParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupRepositoryID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListBackupRepositoriesParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListBackupRepositories(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.BackupRepositories[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.BackupRepositories { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupRepositoryByName(name string, opts ...OptionFunc) (*BackupRepository, int, error) { + id, count, err := s.GetBackupRepositoryID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetBackupRepositoryByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupRepositoryByID(id string, opts ...OptionFunc) (*BackupRepository, int, error) { + p := &ListBackupRepositoriesParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListBackupRepositories(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.BackupRepositories[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for BackupRepository UUID: %s!", id) +} + +// Lists all backup repositories +func (s *BackupService) ListBackupRepositories(p *ListBackupRepositoriesParams) (*ListBackupRepositoriesResponse, error) { + resp, err := s.cs.newRequest("listBackupRepositories", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListBackupRepositoriesResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListBackupRepositoriesResponse struct { + Count int `json:"count"` + BackupRepositories []*BackupRepository `json:"backuprepository"` +} + +type BackupRepository struct { + Address string `json:"address"` + Capacitybytes int64 `json:"capacitybytes"` + Created string `json:"created"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Provider string `json:"provider"` + Type string `json:"type"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type ListBackupScheduleParams struct { + p map[string]interface{} +} + +func (p *ListBackupScheduleParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + return u +} + +func (p *ListBackupScheduleParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *ListBackupScheduleParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *ListBackupScheduleParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +// You should always use this function to get a new ListBackupScheduleParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewListBackupScheduleParams(virtualmachineid string) *ListBackupScheduleParams { + p := &ListBackupScheduleParams{} + p.p = make(map[string]interface{}) + p.p["virtualmachineid"] = virtualmachineid + return p +} + +// List backup schedule of a VM +func (s *BackupService) ListBackupSchedule(p *ListBackupScheduleParams) (*ListBackupScheduleResponse, error) { + resp, err := s.cs.newRequest("listBackupSchedule", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListBackupScheduleResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListBackupScheduleResponse struct { + Count int `json:"count"` + BackupSchedule []*BackupSchedule `json:"backupschedule"` +} + +type BackupSchedule struct { + Id string `json:"id"` + Intervaltype string `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxbackups int `json:"maxbackups"` + Quiescevm bool `json:"quiescevm"` + Schedule string `json:"schedule"` + Timezone string `json:"timezone"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` +} + +type ListBackupsParams struct { + p map[string]interface{} +} + +func (p *ListBackupsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["backupofferingid"]; found { + u.Set("backupofferingid", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["isrecursive"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isrecursive", vv) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["listall"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listall", vv) + } + if v, found := p.p["listvmdetails"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listvmdetails", vv) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListBackupsParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *ListBackupsParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *ListBackupsParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *ListBackupsParams) SetBackupofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["backupofferingid"] = v +} + +func (p *ListBackupsParams) ResetBackupofferingid() { + if p.p != nil && p.p["backupofferingid"] != nil { + delete(p.p, "backupofferingid") + } +} + +func (p *ListBackupsParams) GetBackupofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["backupofferingid"].(string) + return value, ok +} + +func (p *ListBackupsParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *ListBackupsParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *ListBackupsParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *ListBackupsParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListBackupsParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListBackupsParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListBackupsParams) SetIsrecursive(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isrecursive"] = v +} + +func (p *ListBackupsParams) ResetIsrecursive() { + if p.p != nil && p.p["isrecursive"] != nil { + delete(p.p, "isrecursive") + } +} + +func (p *ListBackupsParams) GetIsrecursive() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isrecursive"].(bool) + return value, ok +} + +func (p *ListBackupsParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListBackupsParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListBackupsParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListBackupsParams) SetListall(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listall"] = v +} + +func (p *ListBackupsParams) ResetListall() { + if p.p != nil && p.p["listall"] != nil { + delete(p.p, "listall") + } +} + +func (p *ListBackupsParams) GetListall() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listall"].(bool) + return value, ok +} + +func (p *ListBackupsParams) SetListvmdetails(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listvmdetails"] = v +} + +func (p *ListBackupsParams) ResetListvmdetails() { + if p.p != nil && p.p["listvmdetails"] != nil { + delete(p.p, "listvmdetails") + } +} + +func (p *ListBackupsParams) GetListvmdetails() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listvmdetails"].(bool) + return value, ok +} + +func (p *ListBackupsParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListBackupsParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ListBackupsParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ListBackupsParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListBackupsParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListBackupsParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListBackupsParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListBackupsParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListBackupsParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListBackupsParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListBackupsParams) ResetProjectid() { + if p.p != nil && p.p["projectid"] != nil { + delete(p.p, "projectid") + } +} + +func (p *ListBackupsParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + +func (p *ListBackupsParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *ListBackupsParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *ListBackupsParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +func (p *ListBackupsParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListBackupsParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ListBackupsParams) GetZoneid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["zoneid"].(string) + return value, ok +} + +// You should always use this function to get a new ListBackupsParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewListBackupsParams() *ListBackupsParams { + p := &ListBackupsParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListBackupsParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListBackups(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.Backups[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.Backups { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupByName(name string, opts ...OptionFunc) (*Backup, int, error) { + id, count, err := s.GetBackupID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetBackupByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupByID(id string, opts ...OptionFunc) (*Backup, int, error) { + p := &ListBackupsParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListBackups(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.Backups[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for Backup UUID: %s!", id) +} + +// Lists VM backups +func (s *BackupService) ListBackups(p *ListBackupsParams) (*ListBackupsResponse, error) { + resp, err := s.cs.newRequest("listBackups", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListBackupsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListBackupsResponse struct { + Count int `json:"count"` + Backups []*Backup `json:"backup"` +} + +type Backup struct { + Account string `json:"account"` + Accountid string `json:"accountid"` + Backupofferingid string `json:"backupofferingid"` + Backupofferingname string `json:"backupofferingname"` + Created string `json:"created"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Externalid string `json:"externalid"` + Id string `json:"id"` + Intervaltype string `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Size int64 `json:"size"` + Status string `json:"status"` + Type string `json:"type"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Virtualsize int64 `json:"virtualsize"` + Vmbackupofferingremoved bool `json:"vmbackupofferingremoved"` + Vmdetails map[string]string `json:"vmdetails"` + Volumes string `json:"volumes"` + Zone string `json:"zone"` + Zoneid string `json:"zoneid"` +} + +type RestoreBackupParams struct { + p map[string]interface{} +} + +func (p *RestoreBackupParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *RestoreBackupParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *RestoreBackupParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *RestoreBackupParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new RestoreBackupParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewRestoreBackupParams(id string) *RestoreBackupParams { + p := &RestoreBackupParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Restores an existing stopped or deleted VM using a VM backup +func (s *BackupService) RestoreBackup(p *RestoreBackupParams) (*RestoreBackupResponse, error) { + resp, err := s.cs.newPostRequest("restoreBackup", p.toURLValues()) + if err != nil { + return nil, err + } + + var r RestoreBackupResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type RestoreBackupResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +type UpdateBackupOfferingParams struct { + p map[string]interface{} +} + +func (p *UpdateBackupOfferingParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["allowuserdrivenbackups"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("allowuserdrivenbackups", vv) + } + if v, found := p.p["description"]; found { + u.Set("description", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + return u +} + +func (p *UpdateBackupOfferingParams) SetAllowuserdrivenbackups(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["allowuserdrivenbackups"] = v +} + +func (p *UpdateBackupOfferingParams) ResetAllowuserdrivenbackups() { + if p.p != nil && p.p["allowuserdrivenbackups"] != nil { + delete(p.p, "allowuserdrivenbackups") + } +} + +func (p *UpdateBackupOfferingParams) GetAllowuserdrivenbackups() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["allowuserdrivenbackups"].(bool) + return value, ok +} + +func (p *UpdateBackupOfferingParams) SetDescription(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["description"] = v +} + +func (p *UpdateBackupOfferingParams) ResetDescription() { + if p.p != nil && p.p["description"] != nil { + delete(p.p, "description") + } +} + +func (p *UpdateBackupOfferingParams) GetDescription() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["description"].(string) + return value, ok +} + +func (p *UpdateBackupOfferingParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *UpdateBackupOfferingParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *UpdateBackupOfferingParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *UpdateBackupOfferingParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *UpdateBackupOfferingParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *UpdateBackupOfferingParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +// You should always use this function to get a new UpdateBackupOfferingParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewUpdateBackupOfferingParams(id string) *UpdateBackupOfferingParams { + p := &UpdateBackupOfferingParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Updates a backup offering. +func (s *BackupService) UpdateBackupOffering(p *UpdateBackupOfferingParams) (*UpdateBackupOfferingResponse, error) { + resp, err := s.cs.newPostRequest("updateBackupOffering", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateBackupOfferingResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UpdateBackupOfferingResponse struct { + Allowuserdrivenbackups bool `json:"allowuserdrivenbackups"` + Created string `json:"created"` + Description string `json:"description"` + Externalid string `json:"externalid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Provider string `json:"provider"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type UpdateBackupScheduleParams struct { + p map[string]interface{} +} + +func (p *UpdateBackupScheduleParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["intervaltype"]; found { + u.Set("intervaltype", v.(string)) + } + if v, found := p.p["maxbackups"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("maxbackups", vv) + } + if v, found := p.p["quiescevm"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("quiescevm", vv) + } + if v, found := p.p["schedule"]; found { + u.Set("schedule", v.(string)) + } + if v, found := p.p["timezone"]; found { + u.Set("timezone", v.(string)) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + return u +} + +func (p *UpdateBackupScheduleParams) SetIntervaltype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["intervaltype"] = v +} + +func (p *UpdateBackupScheduleParams) ResetIntervaltype() { + if p.p != nil && p.p["intervaltype"] != nil { + delete(p.p, "intervaltype") + } +} + +func (p *UpdateBackupScheduleParams) GetIntervaltype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["intervaltype"].(string) + return value, ok +} + +func (p *UpdateBackupScheduleParams) SetMaxbackups(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxbackups"] = v +} + +func (p *UpdateBackupScheduleParams) ResetMaxbackups() { + if p.p != nil && p.p["maxbackups"] != nil { + delete(p.p, "maxbackups") + } +} + +func (p *UpdateBackupScheduleParams) GetMaxbackups() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxbackups"].(int) + return value, ok +} + +func (p *UpdateBackupScheduleParams) SetQuiescevm(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["quiescevm"] = v +} + +func (p *UpdateBackupScheduleParams) ResetQuiescevm() { + if p.p != nil && p.p["quiescevm"] != nil { + delete(p.p, "quiescevm") + } +} + +func (p *UpdateBackupScheduleParams) GetQuiescevm() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["quiescevm"].(bool) + return value, ok +} + +func (p *UpdateBackupScheduleParams) SetSchedule(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["schedule"] = v +} + +func (p *UpdateBackupScheduleParams) ResetSchedule() { + if p.p != nil && p.p["schedule"] != nil { + delete(p.p, "schedule") + } +} + +func (p *UpdateBackupScheduleParams) GetSchedule() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["schedule"].(string) + return value, ok +} + +func (p *UpdateBackupScheduleParams) SetTimezone(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["timezone"] = v +} + +func (p *UpdateBackupScheduleParams) ResetTimezone() { + if p.p != nil && p.p["timezone"] != nil { + delete(p.p, "timezone") + } +} + +func (p *UpdateBackupScheduleParams) GetTimezone() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["timezone"].(string) + return value, ok +} + +func (p *UpdateBackupScheduleParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *UpdateBackupScheduleParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *UpdateBackupScheduleParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +// You should always use this function to get a new UpdateBackupScheduleParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewUpdateBackupScheduleParams(intervaltype string, schedule string, timezone string, virtualmachineid string) *UpdateBackupScheduleParams { + p := &UpdateBackupScheduleParams{} + p.p = make(map[string]interface{}) + p.p["intervaltype"] = intervaltype + p.p["schedule"] = schedule + p.p["timezone"] = timezone + p.p["virtualmachineid"] = virtualmachineid + return p +} + +// Updates a user-defined VM backup schedule +func (s *BackupService) UpdateBackupSchedule(p *UpdateBackupScheduleParams) (*UpdateBackupScheduleResponse, error) { + resp, err := s.cs.newPostRequest("updateBackupSchedule", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateBackupScheduleResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UpdateBackupScheduleResponse struct { + Account string `json:"account"` + Accountid string `json:"accountid"` + Backupofferingid string `json:"backupofferingid"` + Backupofferingname string `json:"backupofferingname"` + Created string `json:"created"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Externalid string `json:"externalid"` + Id string `json:"id"` + Intervaltype string `json:"intervaltype"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Size int64 `json:"size"` + Status string `json:"status"` + Type string `json:"type"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Virtualsize int64 `json:"virtualsize"` + Vmbackupofferingremoved bool `json:"vmbackupofferingremoved"` + Vmdetails map[string]string `json:"vmdetails"` + Volumes string `json:"volumes"` + Zone string `json:"zone"` + Zoneid string `json:"zoneid"` +} diff --git a/cloudstack/BackupService_mock.go b/cloudstack/BackupService_mock.go new file mode 100644 index 00000000..66d4e347 --- /dev/null +++ b/cloudstack/BackupService_mock.go @@ -0,0 +1,791 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +// Code generated by MockGen. DO NOT EDIT. +// Source: ./cloudstack/BackupService.go +// +// Generated by this command: +// +// mockgen -destination=./cloudstack/BackupService_mock.go -package=cloudstack -copyright_file=header.txt -source=./cloudstack/BackupService.go +// + +// Package cloudstack is a generated GoMock package. +package cloudstack + +import ( + reflect "reflect" + + gomock "go.uber.org/mock/gomock" +) + +// MockBackupServiceIface is a mock of BackupServiceIface interface. +type MockBackupServiceIface struct { + ctrl *gomock.Controller + recorder *MockBackupServiceIfaceMockRecorder + isgomock struct{} +} + +// MockBackupServiceIfaceMockRecorder is the mock recorder for MockBackupServiceIface. +type MockBackupServiceIfaceMockRecorder struct { + mock *MockBackupServiceIface +} + +// NewMockBackupServiceIface creates a new mock instance. +func NewMockBackupServiceIface(ctrl *gomock.Controller) *MockBackupServiceIface { + mock := &MockBackupServiceIface{ctrl: ctrl} + mock.recorder = &MockBackupServiceIfaceMockRecorder{mock} + return mock +} + +// EXPECT returns an object that allows the caller to indicate expected use. +func (m *MockBackupServiceIface) EXPECT() *MockBackupServiceIfaceMockRecorder { + return m.recorder +} + +// AddBackupRepository mocks base method. +func (m *MockBackupServiceIface) AddBackupRepository(p *AddBackupRepositoryParams) (*AddBackupRepositoryResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "AddBackupRepository", p) + ret0, _ := ret[0].(*AddBackupRepositoryResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// AddBackupRepository indicates an expected call of AddBackupRepository. +func (mr *MockBackupServiceIfaceMockRecorder) AddBackupRepository(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddBackupRepository", reflect.TypeOf((*MockBackupServiceIface)(nil).AddBackupRepository), p) +} + +// CreateBackup mocks base method. +func (m *MockBackupServiceIface) CreateBackup(p *CreateBackupParams) (*CreateBackupResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateBackup", p) + ret0, _ := ret[0].(*CreateBackupResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateBackup indicates an expected call of CreateBackup. +func (mr *MockBackupServiceIfaceMockRecorder) CreateBackup(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateBackup", reflect.TypeOf((*MockBackupServiceIface)(nil).CreateBackup), p) +} + +// CreateBackupSchedule mocks base method. +func (m *MockBackupServiceIface) CreateBackupSchedule(p *CreateBackupScheduleParams) (*CreateBackupScheduleResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateBackupSchedule", p) + ret0, _ := ret[0].(*CreateBackupScheduleResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateBackupSchedule indicates an expected call of CreateBackupSchedule. +func (mr *MockBackupServiceIfaceMockRecorder) CreateBackupSchedule(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateBackupSchedule", reflect.TypeOf((*MockBackupServiceIface)(nil).CreateBackupSchedule), p) +} + +// CreateVMFromBackup mocks base method. +func (m *MockBackupServiceIface) CreateVMFromBackup(p *CreateVMFromBackupParams) (*CreateVMFromBackupResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateVMFromBackup", p) + ret0, _ := ret[0].(*CreateVMFromBackupResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateVMFromBackup indicates an expected call of CreateVMFromBackup. +func (mr *MockBackupServiceIfaceMockRecorder) CreateVMFromBackup(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateVMFromBackup", reflect.TypeOf((*MockBackupServiceIface)(nil).CreateVMFromBackup), p) +} + +// DeleteBackup mocks base method. +func (m *MockBackupServiceIface) DeleteBackup(p *DeleteBackupParams) (*DeleteBackupResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteBackup", p) + ret0, _ := ret[0].(*DeleteBackupResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteBackup indicates an expected call of DeleteBackup. +func (mr *MockBackupServiceIfaceMockRecorder) DeleteBackup(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteBackup", reflect.TypeOf((*MockBackupServiceIface)(nil).DeleteBackup), p) +} + +// DeleteBackupOffering mocks base method. +func (m *MockBackupServiceIface) DeleteBackupOffering(p *DeleteBackupOfferingParams) (*DeleteBackupOfferingResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteBackupOffering", p) + ret0, _ := ret[0].(*DeleteBackupOfferingResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteBackupOffering indicates an expected call of DeleteBackupOffering. +func (mr *MockBackupServiceIfaceMockRecorder) DeleteBackupOffering(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteBackupOffering", reflect.TypeOf((*MockBackupServiceIface)(nil).DeleteBackupOffering), p) +} + +// DeleteBackupRepository mocks base method. +func (m *MockBackupServiceIface) DeleteBackupRepository(p *DeleteBackupRepositoryParams) (*DeleteBackupRepositoryResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteBackupRepository", p) + ret0, _ := ret[0].(*DeleteBackupRepositoryResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteBackupRepository indicates an expected call of DeleteBackupRepository. +func (mr *MockBackupServiceIfaceMockRecorder) DeleteBackupRepository(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteBackupRepository", reflect.TypeOf((*MockBackupServiceIface)(nil).DeleteBackupRepository), p) +} + +// DeleteBackupSchedule mocks base method. +func (m *MockBackupServiceIface) DeleteBackupSchedule(p *DeleteBackupScheduleParams) (*DeleteBackupScheduleResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteBackupSchedule", p) + ret0, _ := ret[0].(*DeleteBackupScheduleResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteBackupSchedule indicates an expected call of DeleteBackupSchedule. +func (mr *MockBackupServiceIfaceMockRecorder) DeleteBackupSchedule(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteBackupSchedule", reflect.TypeOf((*MockBackupServiceIface)(nil).DeleteBackupSchedule), p) +} + +// GetBackupByID mocks base method. +func (m *MockBackupServiceIface) GetBackupByID(id string, opts ...OptionFunc) (*Backup, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupByID", varargs...) + ret0, _ := ret[0].(*Backup) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupByID indicates an expected call of GetBackupByID. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupByID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupByID), varargs...) +} + +// GetBackupByName mocks base method. +func (m *MockBackupServiceIface) GetBackupByName(name string, opts ...OptionFunc) (*Backup, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupByName", varargs...) + ret0, _ := ret[0].(*Backup) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupByName indicates an expected call of GetBackupByName. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupByName(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupByName", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupByName), varargs...) +} + +// GetBackupID mocks base method. +func (m *MockBackupServiceIface) GetBackupID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupID indicates an expected call of GetBackupID. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupID(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupID), varargs...) +} + +// GetBackupOfferingByID mocks base method. +func (m *MockBackupServiceIface) GetBackupOfferingByID(id string, opts ...OptionFunc) (*BackupOffering, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupOfferingByID", varargs...) + ret0, _ := ret[0].(*BackupOffering) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupOfferingByID indicates an expected call of GetBackupOfferingByID. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupOfferingByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupOfferingByID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupOfferingByID), varargs...) +} + +// GetBackupOfferingByName mocks base method. +func (m *MockBackupServiceIface) GetBackupOfferingByName(name string, opts ...OptionFunc) (*BackupOffering, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupOfferingByName", varargs...) + ret0, _ := ret[0].(*BackupOffering) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupOfferingByName indicates an expected call of GetBackupOfferingByName. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupOfferingByName(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupOfferingByName", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupOfferingByName), varargs...) +} + +// GetBackupOfferingID mocks base method. +func (m *MockBackupServiceIface) GetBackupOfferingID(keyword string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{keyword} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupOfferingID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupOfferingID indicates an expected call of GetBackupOfferingID. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupOfferingID(keyword any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{keyword}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupOfferingID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupOfferingID), varargs...) +} + +// GetBackupProviderOfferingID mocks base method. +func (m *MockBackupServiceIface) GetBackupProviderOfferingID(keyword, zoneid string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{keyword, zoneid} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupProviderOfferingID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupProviderOfferingID indicates an expected call of GetBackupProviderOfferingID. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupProviderOfferingID(keyword, zoneid any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{keyword, zoneid}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupProviderOfferingID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupProviderOfferingID), varargs...) +} + +// GetBackupRepositoryByID mocks base method. +func (m *MockBackupServiceIface) GetBackupRepositoryByID(id string, opts ...OptionFunc) (*BackupRepository, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupRepositoryByID", varargs...) + ret0, _ := ret[0].(*BackupRepository) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupRepositoryByID indicates an expected call of GetBackupRepositoryByID. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupRepositoryByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupRepositoryByID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupRepositoryByID), varargs...) +} + +// GetBackupRepositoryByName mocks base method. +func (m *MockBackupServiceIface) GetBackupRepositoryByName(name string, opts ...OptionFunc) (*BackupRepository, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupRepositoryByName", varargs...) + ret0, _ := ret[0].(*BackupRepository) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupRepositoryByName indicates an expected call of GetBackupRepositoryByName. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupRepositoryByName(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupRepositoryByName", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupRepositoryByName), varargs...) +} + +// GetBackupRepositoryID mocks base method. +func (m *MockBackupServiceIface) GetBackupRepositoryID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []any{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupRepositoryID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupRepositoryID indicates an expected call of GetBackupRepositoryID. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupRepositoryID(name any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupRepositoryID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupRepositoryID), varargs...) +} + +// ImportBackupOffering mocks base method. +func (m *MockBackupServiceIface) ImportBackupOffering(p *ImportBackupOfferingParams) (*ImportBackupOfferingResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ImportBackupOffering", p) + ret0, _ := ret[0].(*ImportBackupOfferingResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ImportBackupOffering indicates an expected call of ImportBackupOffering. +func (mr *MockBackupServiceIfaceMockRecorder) ImportBackupOffering(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ImportBackupOffering", reflect.TypeOf((*MockBackupServiceIface)(nil).ImportBackupOffering), p) +} + +// ListBackupOfferings mocks base method. +func (m *MockBackupServiceIface) ListBackupOfferings(p *ListBackupOfferingsParams) (*ListBackupOfferingsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListBackupOfferings", p) + ret0, _ := ret[0].(*ListBackupOfferingsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListBackupOfferings indicates an expected call of ListBackupOfferings. +func (mr *MockBackupServiceIfaceMockRecorder) ListBackupOfferings(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListBackupOfferings", reflect.TypeOf((*MockBackupServiceIface)(nil).ListBackupOfferings), p) +} + +// ListBackupProviderOfferings mocks base method. +func (m *MockBackupServiceIface) ListBackupProviderOfferings(p *ListBackupProviderOfferingsParams) (*ListBackupProviderOfferingsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListBackupProviderOfferings", p) + ret0, _ := ret[0].(*ListBackupProviderOfferingsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListBackupProviderOfferings indicates an expected call of ListBackupProviderOfferings. +func (mr *MockBackupServiceIfaceMockRecorder) ListBackupProviderOfferings(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListBackupProviderOfferings", reflect.TypeOf((*MockBackupServiceIface)(nil).ListBackupProviderOfferings), p) +} + +// ListBackupProviders mocks base method. +func (m *MockBackupServiceIface) ListBackupProviders(p *ListBackupProvidersParams) (*ListBackupProvidersResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListBackupProviders", p) + ret0, _ := ret[0].(*ListBackupProvidersResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListBackupProviders indicates an expected call of ListBackupProviders. +func (mr *MockBackupServiceIfaceMockRecorder) ListBackupProviders(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListBackupProviders", reflect.TypeOf((*MockBackupServiceIface)(nil).ListBackupProviders), p) +} + +// ListBackupRepositories mocks base method. +func (m *MockBackupServiceIface) ListBackupRepositories(p *ListBackupRepositoriesParams) (*ListBackupRepositoriesResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListBackupRepositories", p) + ret0, _ := ret[0].(*ListBackupRepositoriesResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListBackupRepositories indicates an expected call of ListBackupRepositories. +func (mr *MockBackupServiceIfaceMockRecorder) ListBackupRepositories(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListBackupRepositories", reflect.TypeOf((*MockBackupServiceIface)(nil).ListBackupRepositories), p) +} + +// ListBackupSchedule mocks base method. +func (m *MockBackupServiceIface) ListBackupSchedule(p *ListBackupScheduleParams) (*ListBackupScheduleResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListBackupSchedule", p) + ret0, _ := ret[0].(*ListBackupScheduleResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListBackupSchedule indicates an expected call of ListBackupSchedule. +func (mr *MockBackupServiceIfaceMockRecorder) ListBackupSchedule(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListBackupSchedule", reflect.TypeOf((*MockBackupServiceIface)(nil).ListBackupSchedule), p) +} + +// ListBackups mocks base method. +func (m *MockBackupServiceIface) ListBackups(p *ListBackupsParams) (*ListBackupsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListBackups", p) + ret0, _ := ret[0].(*ListBackupsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListBackups indicates an expected call of ListBackups. +func (mr *MockBackupServiceIfaceMockRecorder) ListBackups(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListBackups", reflect.TypeOf((*MockBackupServiceIface)(nil).ListBackups), p) +} + +// NewAddBackupRepositoryParams mocks base method. +func (m *MockBackupServiceIface) NewAddBackupRepositoryParams(address, name, backupType, zoneid string) *AddBackupRepositoryParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewAddBackupRepositoryParams", address, name, backupType, zoneid) + ret0, _ := ret[0].(*AddBackupRepositoryParams) + return ret0 +} + +// NewAddBackupRepositoryParams indicates an expected call of NewAddBackupRepositoryParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewAddBackupRepositoryParams(address, name, backupType, zoneid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAddBackupRepositoryParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewAddBackupRepositoryParams), address, name, backupType, zoneid) +} + +// NewCreateBackupParams mocks base method. +func (m *MockBackupServiceIface) NewCreateBackupParams(virtualmachineid string) *CreateBackupParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateBackupParams", virtualmachineid) + ret0, _ := ret[0].(*CreateBackupParams) + return ret0 +} + +// NewCreateBackupParams indicates an expected call of NewCreateBackupParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewCreateBackupParams(virtualmachineid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateBackupParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewCreateBackupParams), virtualmachineid) +} + +// NewCreateBackupScheduleParams mocks base method. +func (m *MockBackupServiceIface) NewCreateBackupScheduleParams(intervaltype, schedule, timezone, virtualmachineid string) *CreateBackupScheduleParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateBackupScheduleParams", intervaltype, schedule, timezone, virtualmachineid) + ret0, _ := ret[0].(*CreateBackupScheduleParams) + return ret0 +} + +// NewCreateBackupScheduleParams indicates an expected call of NewCreateBackupScheduleParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewCreateBackupScheduleParams(intervaltype, schedule, timezone, virtualmachineid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateBackupScheduleParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewCreateBackupScheduleParams), intervaltype, schedule, timezone, virtualmachineid) +} + +// NewCreateVMFromBackupParams mocks base method. +func (m *MockBackupServiceIface) NewCreateVMFromBackupParams(backupid, zoneid string) *CreateVMFromBackupParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateVMFromBackupParams", backupid, zoneid) + ret0, _ := ret[0].(*CreateVMFromBackupParams) + return ret0 +} + +// NewCreateVMFromBackupParams indicates an expected call of NewCreateVMFromBackupParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewCreateVMFromBackupParams(backupid, zoneid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateVMFromBackupParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewCreateVMFromBackupParams), backupid, zoneid) +} + +// NewDeleteBackupOfferingParams mocks base method. +func (m *MockBackupServiceIface) NewDeleteBackupOfferingParams(id string) *DeleteBackupOfferingParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteBackupOfferingParams", id) + ret0, _ := ret[0].(*DeleteBackupOfferingParams) + return ret0 +} + +// NewDeleteBackupOfferingParams indicates an expected call of NewDeleteBackupOfferingParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewDeleteBackupOfferingParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteBackupOfferingParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewDeleteBackupOfferingParams), id) +} + +// NewDeleteBackupParams mocks base method. +func (m *MockBackupServiceIface) NewDeleteBackupParams(id string) *DeleteBackupParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteBackupParams", id) + ret0, _ := ret[0].(*DeleteBackupParams) + return ret0 +} + +// NewDeleteBackupParams indicates an expected call of NewDeleteBackupParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewDeleteBackupParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteBackupParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewDeleteBackupParams), id) +} + +// NewDeleteBackupRepositoryParams mocks base method. +func (m *MockBackupServiceIface) NewDeleteBackupRepositoryParams(id string) *DeleteBackupRepositoryParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteBackupRepositoryParams", id) + ret0, _ := ret[0].(*DeleteBackupRepositoryParams) + return ret0 +} + +// NewDeleteBackupRepositoryParams indicates an expected call of NewDeleteBackupRepositoryParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewDeleteBackupRepositoryParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteBackupRepositoryParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewDeleteBackupRepositoryParams), id) +} + +// NewDeleteBackupScheduleParams mocks base method. +func (m *MockBackupServiceIface) NewDeleteBackupScheduleParams() *DeleteBackupScheduleParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteBackupScheduleParams") + ret0, _ := ret[0].(*DeleteBackupScheduleParams) + return ret0 +} + +// NewDeleteBackupScheduleParams indicates an expected call of NewDeleteBackupScheduleParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewDeleteBackupScheduleParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteBackupScheduleParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewDeleteBackupScheduleParams)) +} + +// NewImportBackupOfferingParams mocks base method. +func (m *MockBackupServiceIface) NewImportBackupOfferingParams(allowuserdrivenbackups bool, description, externalid, name, zoneid string) *ImportBackupOfferingParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewImportBackupOfferingParams", allowuserdrivenbackups, description, externalid, name, zoneid) + ret0, _ := ret[0].(*ImportBackupOfferingParams) + return ret0 +} + +// NewImportBackupOfferingParams indicates an expected call of NewImportBackupOfferingParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewImportBackupOfferingParams(allowuserdrivenbackups, description, externalid, name, zoneid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewImportBackupOfferingParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewImportBackupOfferingParams), allowuserdrivenbackups, description, externalid, name, zoneid) +} + +// NewListBackupOfferingsParams mocks base method. +func (m *MockBackupServiceIface) NewListBackupOfferingsParams() *ListBackupOfferingsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListBackupOfferingsParams") + ret0, _ := ret[0].(*ListBackupOfferingsParams) + return ret0 +} + +// NewListBackupOfferingsParams indicates an expected call of NewListBackupOfferingsParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupOfferingsParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListBackupOfferingsParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewListBackupOfferingsParams)) +} + +// NewListBackupProviderOfferingsParams mocks base method. +func (m *MockBackupServiceIface) NewListBackupProviderOfferingsParams(zoneid string) *ListBackupProviderOfferingsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListBackupProviderOfferingsParams", zoneid) + ret0, _ := ret[0].(*ListBackupProviderOfferingsParams) + return ret0 +} + +// NewListBackupProviderOfferingsParams indicates an expected call of NewListBackupProviderOfferingsParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupProviderOfferingsParams(zoneid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListBackupProviderOfferingsParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewListBackupProviderOfferingsParams), zoneid) +} + +// NewListBackupProvidersParams mocks base method. +func (m *MockBackupServiceIface) NewListBackupProvidersParams() *ListBackupProvidersParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListBackupProvidersParams") + ret0, _ := ret[0].(*ListBackupProvidersParams) + return ret0 +} + +// NewListBackupProvidersParams indicates an expected call of NewListBackupProvidersParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupProvidersParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListBackupProvidersParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewListBackupProvidersParams)) +} + +// NewListBackupRepositoriesParams mocks base method. +func (m *MockBackupServiceIface) NewListBackupRepositoriesParams() *ListBackupRepositoriesParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListBackupRepositoriesParams") + ret0, _ := ret[0].(*ListBackupRepositoriesParams) + return ret0 +} + +// NewListBackupRepositoriesParams indicates an expected call of NewListBackupRepositoriesParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupRepositoriesParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListBackupRepositoriesParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewListBackupRepositoriesParams)) +} + +// NewListBackupScheduleParams mocks base method. +func (m *MockBackupServiceIface) NewListBackupScheduleParams(virtualmachineid string) *ListBackupScheduleParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListBackupScheduleParams", virtualmachineid) + ret0, _ := ret[0].(*ListBackupScheduleParams) + return ret0 +} + +// NewListBackupScheduleParams indicates an expected call of NewListBackupScheduleParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupScheduleParams(virtualmachineid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListBackupScheduleParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewListBackupScheduleParams), virtualmachineid) +} + +// NewListBackupsParams mocks base method. +func (m *MockBackupServiceIface) NewListBackupsParams() *ListBackupsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListBackupsParams") + ret0, _ := ret[0].(*ListBackupsParams) + return ret0 +} + +// NewListBackupsParams indicates an expected call of NewListBackupsParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupsParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListBackupsParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewListBackupsParams)) +} + +// NewRestoreBackupParams mocks base method. +func (m *MockBackupServiceIface) NewRestoreBackupParams(id string) *RestoreBackupParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewRestoreBackupParams", id) + ret0, _ := ret[0].(*RestoreBackupParams) + return ret0 +} + +// NewRestoreBackupParams indicates an expected call of NewRestoreBackupParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewRestoreBackupParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRestoreBackupParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewRestoreBackupParams), id) +} + +// NewUpdateBackupOfferingParams mocks base method. +func (m *MockBackupServiceIface) NewUpdateBackupOfferingParams(id string) *UpdateBackupOfferingParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateBackupOfferingParams", id) + ret0, _ := ret[0].(*UpdateBackupOfferingParams) + return ret0 +} + +// NewUpdateBackupOfferingParams indicates an expected call of NewUpdateBackupOfferingParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewUpdateBackupOfferingParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateBackupOfferingParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewUpdateBackupOfferingParams), id) +} + +// NewUpdateBackupScheduleParams mocks base method. +func (m *MockBackupServiceIface) NewUpdateBackupScheduleParams(intervaltype, schedule, timezone, virtualmachineid string) *UpdateBackupScheduleParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateBackupScheduleParams", intervaltype, schedule, timezone, virtualmachineid) + ret0, _ := ret[0].(*UpdateBackupScheduleParams) + return ret0 +} + +// NewUpdateBackupScheduleParams indicates an expected call of NewUpdateBackupScheduleParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewUpdateBackupScheduleParams(intervaltype, schedule, timezone, virtualmachineid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateBackupScheduleParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewUpdateBackupScheduleParams), intervaltype, schedule, timezone, virtualmachineid) +} + +// RestoreBackup mocks base method. +func (m *MockBackupServiceIface) RestoreBackup(p *RestoreBackupParams) (*RestoreBackupResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "RestoreBackup", p) + ret0, _ := ret[0].(*RestoreBackupResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// RestoreBackup indicates an expected call of RestoreBackup. +func (mr *MockBackupServiceIfaceMockRecorder) RestoreBackup(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RestoreBackup", reflect.TypeOf((*MockBackupServiceIface)(nil).RestoreBackup), p) +} + +// UpdateBackupOffering mocks base method. +func (m *MockBackupServiceIface) UpdateBackupOffering(p *UpdateBackupOfferingParams) (*UpdateBackupOfferingResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateBackupOffering", p) + ret0, _ := ret[0].(*UpdateBackupOfferingResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateBackupOffering indicates an expected call of UpdateBackupOffering. +func (mr *MockBackupServiceIfaceMockRecorder) UpdateBackupOffering(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateBackupOffering", reflect.TypeOf((*MockBackupServiceIface)(nil).UpdateBackupOffering), p) +} + +// UpdateBackupSchedule mocks base method. +func (m *MockBackupServiceIface) UpdateBackupSchedule(p *UpdateBackupScheduleParams) (*UpdateBackupScheduleResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateBackupSchedule", p) + ret0, _ := ret[0].(*UpdateBackupScheduleResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateBackupSchedule indicates an expected call of UpdateBackupSchedule. +func (mr *MockBackupServiceIfaceMockRecorder) UpdateBackupSchedule(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateBackupSchedule", reflect.TypeOf((*MockBackupServiceIface)(nil).UpdateBackupSchedule), p) +} diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 3cd67fb2..04d30920 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -104,6 +104,10 @@ type VirtualMachineServiceIface interface { GetVMScheduleByID(id string, virtualmachineid string, opts ...OptionFunc) (*VMSchedule, int, error) DeleteVMSchedule(p *DeleteVMScheduleParams) (*DeleteVMScheduleResponse, error) NewDeleteVMScheduleParams(virtualmachineid string) *DeleteVMScheduleParams + AssignVirtualMachineToBackupOffering(p *AssignVirtualMachineToBackupOfferingParams) (*AssignVirtualMachineToBackupOfferingResponse, error) + NewAssignVirtualMachineToBackupOfferingParams(backupofferingid string, virtualmachineid string) *AssignVirtualMachineToBackupOfferingParams + RemoveVirtualMachineFromBackupOffering(p *RemoveVirtualMachineFromBackupOfferingParams) (*RemoveVirtualMachineFromBackupOfferingResponse, error) + NewRemoveVirtualMachineFromBackupOfferingParams(virtualmachineid string) *RemoveVirtualMachineFromBackupOfferingParams } type AddNicToVirtualMachineParams struct { @@ -14366,3 +14370,217 @@ func (r *DeleteVMScheduleResponse) UnmarshalJSON(b []byte) error { type alias DeleteVMScheduleResponse return json.Unmarshal(b, (*alias)(r)) } + +type AssignVirtualMachineToBackupOfferingParams struct { + p map[string]interface{} +} + +func (p *AssignVirtualMachineToBackupOfferingParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["backupofferingid"]; found { + u.Set("backupofferingid", v.(string)) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + return u +} + +func (p *AssignVirtualMachineToBackupOfferingParams) SetBackupofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["backupofferingid"] = v +} + +func (p *AssignVirtualMachineToBackupOfferingParams) ResetBackupofferingid() { + if p.p != nil && p.p["backupofferingid"] != nil { + delete(p.p, "backupofferingid") + } +} + +func (p *AssignVirtualMachineToBackupOfferingParams) GetBackupofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["backupofferingid"].(string) + return value, ok +} + +func (p *AssignVirtualMachineToBackupOfferingParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *AssignVirtualMachineToBackupOfferingParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *AssignVirtualMachineToBackupOfferingParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +// You should always use this function to get a new AssignVirtualMachineToBackupOfferingParams instance, +// as then you are sure you have configured all required params +func (s *VirtualMachineService) NewAssignVirtualMachineToBackupOfferingParams(backupofferingid string, virtualmachineid string) *AssignVirtualMachineToBackupOfferingParams { + p := &AssignVirtualMachineToBackupOfferingParams{} + p.p = make(map[string]interface{}) + p.p["backupofferingid"] = backupofferingid + p.p["virtualmachineid"] = virtualmachineid + return p +} + +// Assigns a VM to a backup offering +func (s *VirtualMachineService) AssignVirtualMachineToBackupOffering(p *AssignVirtualMachineToBackupOfferingParams) (*AssignVirtualMachineToBackupOfferingResponse, error) { + resp, err := s.cs.newPostRequest("assignVirtualMachineToBackupOffering", p.toURLValues()) + if err != nil { + return nil, err + } + + var r AssignVirtualMachineToBackupOfferingResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type AssignVirtualMachineToBackupOfferingResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +type RemoveVirtualMachineFromBackupOfferingParams struct { + p map[string]interface{} +} + +func (p *RemoveVirtualMachineFromBackupOfferingParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["forced"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forced", vv) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + return u +} + +func (p *RemoveVirtualMachineFromBackupOfferingParams) SetForced(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forced"] = v +} + +func (p *RemoveVirtualMachineFromBackupOfferingParams) ResetForced() { + if p.p != nil && p.p["forced"] != nil { + delete(p.p, "forced") + } +} + +func (p *RemoveVirtualMachineFromBackupOfferingParams) GetForced() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forced"].(bool) + return value, ok +} + +func (p *RemoveVirtualMachineFromBackupOfferingParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *RemoveVirtualMachineFromBackupOfferingParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *RemoveVirtualMachineFromBackupOfferingParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +// You should always use this function to get a new RemoveVirtualMachineFromBackupOfferingParams instance, +// as then you are sure you have configured all required params +func (s *VirtualMachineService) NewRemoveVirtualMachineFromBackupOfferingParams(virtualmachineid string) *RemoveVirtualMachineFromBackupOfferingParams { + p := &RemoveVirtualMachineFromBackupOfferingParams{} + p.p = make(map[string]interface{}) + p.p["virtualmachineid"] = virtualmachineid + return p +} + +// Removes a VM from any existing backup offering +func (s *VirtualMachineService) RemoveVirtualMachineFromBackupOffering(p *RemoveVirtualMachineFromBackupOfferingParams) (*RemoveVirtualMachineFromBackupOfferingResponse, error) { + resp, err := s.cs.newPostRequest("removeVirtualMachineFromBackupOffering", p.toURLValues()) + if err != nil { + return nil, err + } + + var r RemoveVirtualMachineFromBackupOfferingResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type RemoveVirtualMachineFromBackupOfferingResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} diff --git a/cloudstack/VirtualMachineService_mock.go b/cloudstack/VirtualMachineService_mock.go index 75c6e86c..c8c4b02b 100644 --- a/cloudstack/VirtualMachineService_mock.go +++ b/cloudstack/VirtualMachineService_mock.go @@ -88,6 +88,21 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) AssignVirtualMachine(p any return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AssignVirtualMachine", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).AssignVirtualMachine), p) } +// AssignVirtualMachineToBackupOffering mocks base method. +func (m *MockVirtualMachineServiceIface) AssignVirtualMachineToBackupOffering(p *AssignVirtualMachineToBackupOfferingParams) (*AssignVirtualMachineToBackupOfferingResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "AssignVirtualMachineToBackupOffering", p) + ret0, _ := ret[0].(*AssignVirtualMachineToBackupOfferingResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// AssignVirtualMachineToBackupOffering indicates an expected call of AssignVirtualMachineToBackupOffering. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) AssignVirtualMachineToBackupOffering(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AssignVirtualMachineToBackupOffering", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).AssignVirtualMachineToBackupOffering), p) +} + // ChangeServiceForVirtualMachine mocks base method. func (m *MockVirtualMachineServiceIface) ChangeServiceForVirtualMachine(p *ChangeServiceForVirtualMachineParams) (*ChangeServiceForVirtualMachineResponse, error) { m.ctrl.T.Helper() @@ -596,6 +611,20 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewAssignVirtualMachinePar return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAssignVirtualMachineParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewAssignVirtualMachineParams), virtualmachineid) } +// NewAssignVirtualMachineToBackupOfferingParams mocks base method. +func (m *MockVirtualMachineServiceIface) NewAssignVirtualMachineToBackupOfferingParams(backupofferingid, virtualmachineid string) *AssignVirtualMachineToBackupOfferingParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewAssignVirtualMachineToBackupOfferingParams", backupofferingid, virtualmachineid) + ret0, _ := ret[0].(*AssignVirtualMachineToBackupOfferingParams) + return ret0 +} + +// NewAssignVirtualMachineToBackupOfferingParams indicates an expected call of NewAssignVirtualMachineToBackupOfferingParams. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewAssignVirtualMachineToBackupOfferingParams(backupofferingid, virtualmachineid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAssignVirtualMachineToBackupOfferingParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewAssignVirtualMachineToBackupOfferingParams), backupofferingid, virtualmachineid) +} + // NewChangeServiceForVirtualMachineParams mocks base method. func (m *MockVirtualMachineServiceIface) NewChangeServiceForVirtualMachineParams(id, serviceofferingid string) *ChangeServiceForVirtualMachineParams { m.ctrl.T.Helper() @@ -890,6 +919,20 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewRemoveNicFromVirtualMac return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRemoveNicFromVirtualMachineParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewRemoveNicFromVirtualMachineParams), nicid, virtualmachineid) } +// NewRemoveVirtualMachineFromBackupOfferingParams mocks base method. +func (m *MockVirtualMachineServiceIface) NewRemoveVirtualMachineFromBackupOfferingParams(virtualmachineid string) *RemoveVirtualMachineFromBackupOfferingParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewRemoveVirtualMachineFromBackupOfferingParams", virtualmachineid) + ret0, _ := ret[0].(*RemoveVirtualMachineFromBackupOfferingParams) + return ret0 +} + +// NewRemoveVirtualMachineFromBackupOfferingParams indicates an expected call of NewRemoveVirtualMachineFromBackupOfferingParams. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewRemoveVirtualMachineFromBackupOfferingParams(virtualmachineid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRemoveVirtualMachineFromBackupOfferingParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewRemoveVirtualMachineFromBackupOfferingParams), virtualmachineid) +} + // NewResetPasswordForVirtualMachineParams mocks base method. func (m *MockVirtualMachineServiceIface) NewResetPasswordForVirtualMachineParams(id string) *ResetPasswordForVirtualMachineParams { m.ctrl.T.Helper() @@ -1075,6 +1118,21 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) RemoveNicFromVirtualMachin return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RemoveNicFromVirtualMachine", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).RemoveNicFromVirtualMachine), p) } +// RemoveVirtualMachineFromBackupOffering mocks base method. +func (m *MockVirtualMachineServiceIface) RemoveVirtualMachineFromBackupOffering(p *RemoveVirtualMachineFromBackupOfferingParams) (*RemoveVirtualMachineFromBackupOfferingResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "RemoveVirtualMachineFromBackupOffering", p) + ret0, _ := ret[0].(*RemoveVirtualMachineFromBackupOfferingResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// RemoveVirtualMachineFromBackupOffering indicates an expected call of RemoveVirtualMachineFromBackupOffering. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) RemoveVirtualMachineFromBackupOffering(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RemoveVirtualMachineFromBackupOffering", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).RemoveVirtualMachineFromBackupOffering), p) +} + // ResetPasswordForVirtualMachine mocks base method. func (m *MockVirtualMachineServiceIface) ResetPasswordForVirtualMachine(p *ResetPasswordForVirtualMachineParams) (*ResetPasswordForVirtualMachineResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/VolumeService.go b/cloudstack/VolumeService.go index 64447162..c9158aa5 100644 --- a/cloudstack/VolumeService.go +++ b/cloudstack/VolumeService.go @@ -86,6 +86,8 @@ type VolumeServiceIface interface { GetVolumesUsageHistoryByID(id string, opts ...OptionFunc) (*VolumesUsageHistory, int, error) AssignVolume(p *AssignVolumeParams) (*AssignVolumeResponse, error) NewAssignVolumeParams(volumeid string) *AssignVolumeParams + RestoreVolumeFromBackupAndAttachToVM(p *RestoreVolumeFromBackupAndAttachToVMParams) (*RestoreVolumeFromBackupAndAttachToVMResponse, error) + NewRestoreVolumeFromBackupAndAttachToVMParams(backupid string, virtualmachineid string, volumeid string) *RestoreVolumeFromBackupAndAttachToVMParams } type AttachVolumeParams struct { @@ -6534,3 +6536,135 @@ type AssignVolumeResponse struct { Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } + +type RestoreVolumeFromBackupAndAttachToVMParams struct { + p map[string]interface{} +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["backupid"]; found { + u.Set("backupid", v.(string)) + } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } + if v, found := p.p["volumeid"]; found { + u.Set("volumeid", v.(string)) + } + return u +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) SetBackupid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["backupid"] = v +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) ResetBackupid() { + if p.p != nil && p.p["backupid"] != nil { + delete(p.p, "backupid") + } +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) GetBackupid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["backupid"].(string) + return value, ok +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) SetVolumeid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["volumeid"] = v +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) ResetVolumeid() { + if p.p != nil && p.p["volumeid"] != nil { + delete(p.p, "volumeid") + } +} + +func (p *RestoreVolumeFromBackupAndAttachToVMParams) GetVolumeid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["volumeid"].(string) + return value, ok +} + +// You should always use this function to get a new RestoreVolumeFromBackupAndAttachToVMParams instance, +// as then you are sure you have configured all required params +func (s *VolumeService) NewRestoreVolumeFromBackupAndAttachToVMParams(backupid string, virtualmachineid string, volumeid string) *RestoreVolumeFromBackupAndAttachToVMParams { + p := &RestoreVolumeFromBackupAndAttachToVMParams{} + p.p = make(map[string]interface{}) + p.p["backupid"] = backupid + p.p["virtualmachineid"] = virtualmachineid + p.p["volumeid"] = volumeid + return p +} + +// Restore and attach a backed up volume to VM +func (s *VolumeService) RestoreVolumeFromBackupAndAttachToVM(p *RestoreVolumeFromBackupAndAttachToVMParams) (*RestoreVolumeFromBackupAndAttachToVMResponse, error) { + resp, err := s.cs.newPostRequest("restoreVolumeFromBackupAndAttachToVM", p.toURLValues()) + if err != nil { + return nil, err + } + + var r RestoreVolumeFromBackupAndAttachToVMResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type RestoreVolumeFromBackupAndAttachToVMResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} diff --git a/cloudstack/VolumeService_mock.go b/cloudstack/VolumeService_mock.go index cf0179e2..86ea903d 100644 --- a/cloudstack/VolumeService_mock.go +++ b/cloudstack/VolumeService_mock.go @@ -847,6 +847,20 @@ func (mr *MockVolumeServiceIfaceMockRecorder) NewResizeVolumeParams(id any) *gom return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewResizeVolumeParams", reflect.TypeOf((*MockVolumeServiceIface)(nil).NewResizeVolumeParams), id) } +// NewRestoreVolumeFromBackupAndAttachToVMParams mocks base method. +func (m *MockVolumeServiceIface) NewRestoreVolumeFromBackupAndAttachToVMParams(backupid, virtualmachineid, volumeid string) *RestoreVolumeFromBackupAndAttachToVMParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewRestoreVolumeFromBackupAndAttachToVMParams", backupid, virtualmachineid, volumeid) + ret0, _ := ret[0].(*RestoreVolumeFromBackupAndAttachToVMParams) + return ret0 +} + +// NewRestoreVolumeFromBackupAndAttachToVMParams indicates an expected call of NewRestoreVolumeFromBackupAndAttachToVMParams. +func (mr *MockVolumeServiceIfaceMockRecorder) NewRestoreVolumeFromBackupAndAttachToVMParams(backupid, virtualmachineid, volumeid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRestoreVolumeFromBackupAndAttachToVMParams", reflect.TypeOf((*MockVolumeServiceIface)(nil).NewRestoreVolumeFromBackupAndAttachToVMParams), backupid, virtualmachineid, volumeid) +} + // NewUnmanageVolumeParams mocks base method. func (m *MockVolumeServiceIface) NewUnmanageVolumeParams(id string) *UnmanageVolumeParams { m.ctrl.T.Helper() @@ -919,6 +933,21 @@ func (mr *MockVolumeServiceIfaceMockRecorder) ResizeVolume(p any) *gomock.Call { return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ResizeVolume", reflect.TypeOf((*MockVolumeServiceIface)(nil).ResizeVolume), p) } +// RestoreVolumeFromBackupAndAttachToVM mocks base method. +func (m *MockVolumeServiceIface) RestoreVolumeFromBackupAndAttachToVM(p *RestoreVolumeFromBackupAndAttachToVMParams) (*RestoreVolumeFromBackupAndAttachToVMResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "RestoreVolumeFromBackupAndAttachToVM", p) + ret0, _ := ret[0].(*RestoreVolumeFromBackupAndAttachToVMResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// RestoreVolumeFromBackupAndAttachToVM indicates an expected call of RestoreVolumeFromBackupAndAttachToVM. +func (mr *MockVolumeServiceIfaceMockRecorder) RestoreVolumeFromBackupAndAttachToVM(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RestoreVolumeFromBackupAndAttachToVM", reflect.TypeOf((*MockVolumeServiceIface)(nil).RestoreVolumeFromBackupAndAttachToVM), p) +} + // UnmanageVolume mocks base method. func (m *MockVolumeServiceIface) UnmanageVolume(p *UnmanageVolumeParams) (*UnmanageVolumeResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index c7ef9f38..e16a9341 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -111,6 +111,7 @@ type CloudStackClient struct { Authentication AuthenticationServiceIface AutoScale AutoScaleServiceIface BGPPeer BGPPeerServiceIface + Backup BackupServiceIface Baremetal BaremetalServiceIface BigSwitchBCF BigSwitchBCFServiceIface BrocadeVCS BrocadeVCSServiceIface @@ -242,6 +243,7 @@ func newClient(apiurl string, apikey string, secret string, async bool, verifyss cs.Authentication = NewAuthenticationService(cs) cs.AutoScale = NewAutoScaleService(cs) cs.BGPPeer = NewBGPPeerService(cs) + cs.Backup = NewBackupService(cs) cs.Baremetal = NewBaremetalService(cs) cs.BigSwitchBCF = NewBigSwitchBCFService(cs) cs.BrocadeVCS = NewBrocadeVCSService(cs) @@ -346,6 +348,7 @@ func newMockClient(ctrl *gomock.Controller) *CloudStackClient { cs.Authentication = NewMockAuthenticationServiceIface(ctrl) cs.AutoScale = NewMockAutoScaleServiceIface(ctrl) cs.BGPPeer = NewMockBGPPeerServiceIface(ctrl) + cs.Backup = NewMockBackupServiceIface(ctrl) cs.Baremetal = NewMockBaremetalServiceIface(ctrl) cs.BigSwitchBCF = NewMockBigSwitchBCFServiceIface(ctrl) cs.BrocadeVCS = NewMockBrocadeVCSServiceIface(ctrl) @@ -912,6 +915,14 @@ func NewBGPPeerService(cs *CloudStackClient) BGPPeerServiceIface { return &BGPPeerService{cs: cs} } +type BackupService struct { + cs *CloudStackClient +} + +func NewBackupService(cs *CloudStackClient) BackupServiceIface { + return &BackupService{cs: cs} +} + type BaremetalService struct { cs *CloudStackClient } diff --git a/generate/layout.go b/generate/layout.go index 77c56320..584ee589 100644 --- a/generate/layout.go +++ b/generate/layout.go @@ -154,6 +154,8 @@ var layout = apiInfo{ "updateVMSchedule", "listVMSchedule", "deleteVMSchedule", + "assignVirtualMachineToBackupOffering", + "removeVirtualMachineFromBackupOffering", }, "VPNService": { "addVpnUser", @@ -285,6 +287,7 @@ var layout = apiInfo{ "uploadVolume", "listVolumesUsageHistory", "assignVolume", + "restoreVolumeFromBackupAndAttachToVM", }, "VPCService": { "createPrivateGateway", @@ -761,6 +764,26 @@ var layout = apiInfo{ "listCniConfiguration", "deleteCniConfiguration", }, + "BackupService": { + "addBackupRepository", + "createBackup", + "createBackupSchedule", + "createVMFromBackup", + "deleteBackup", + "deleteBackupOffering", + "deleteBackupRepository", + "deleteBackupSchedule", + "importBackupOffering", + "listBackupOfferings", + "listBackupProviderOfferings", + "listBackupProviders", + "listBackupRepositories", + "listBackupSchedule", + "listBackups", + "restoreBackup", + "updateBackupOffering", + "updateBackupSchedule", + }, "BrocadeVCSService": { "addBrocadeVcsDevice", "deleteBrocadeVcsDevice", diff --git a/test/BackupService_test.go b/test/BackupService_test.go new file mode 100644 index 00000000..9fa8329b --- /dev/null +++ b/test/BackupService_test.go @@ -0,0 +1,272 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package test + +import ( + "testing" + + "github.com/apache/cloudstack-go/v2/cloudstack" +) + +func TestBackupService(t *testing.T) { + service := "BackupService" + response, err := readData(service) + if err != nil { + t.Skipf("Skipping test as %v", err) + } + server := CreateTestServer(t, response) + client := cloudstack.NewClient(server.URL, "APIKEY", "SECRETKEY", true) + defer server.Close() + + testaddBackupRepository := func(t *testing.T) { + if _, ok := response["addBackupRepository"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewAddBackupRepositoryParams("address", "name", "type", "zoneid") + r, err := client.Backup.AddBackupRepository(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("AddBackupRepository", testaddBackupRepository) + + testcreateBackup := func(t *testing.T) { + if _, ok := response["createBackup"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewCreateBackupParams("virtualmachineid") + _, err := client.Backup.CreateBackup(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("CreateBackup", testcreateBackup) + + testcreateBackupSchedule := func(t *testing.T) { + if _, ok := response["createBackupSchedule"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewCreateBackupScheduleParams("intervaltype", "schedule", "timezone", "virtualmachineid") + r, err := client.Backup.CreateBackupSchedule(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("CreateBackupSchedule", testcreateBackupSchedule) + + testcreateVMFromBackup := func(t *testing.T) { + if _, ok := response["createVMFromBackup"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewCreateVMFromBackupParams("backupid", "zoneid") + r, err := client.Backup.CreateVMFromBackup(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("CreateVMFromBackup", testcreateVMFromBackup) + + testdeleteBackup := func(t *testing.T) { + if _, ok := response["deleteBackup"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewDeleteBackupParams("id") + _, err := client.Backup.DeleteBackup(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteBackup", testdeleteBackup) + + testdeleteBackupOffering := func(t *testing.T) { + if _, ok := response["deleteBackupOffering"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewDeleteBackupOfferingParams("id") + _, err := client.Backup.DeleteBackupOffering(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteBackupOffering", testdeleteBackupOffering) + + testdeleteBackupRepository := func(t *testing.T) { + if _, ok := response["deleteBackupRepository"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewDeleteBackupRepositoryParams("id") + _, err := client.Backup.DeleteBackupRepository(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteBackupRepository", testdeleteBackupRepository) + + testdeleteBackupSchedule := func(t *testing.T) { + if _, ok := response["deleteBackupSchedule"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewDeleteBackupScheduleParams() + _, err := client.Backup.DeleteBackupSchedule(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteBackupSchedule", testdeleteBackupSchedule) + + testimportBackupOffering := func(t *testing.T) { + if _, ok := response["importBackupOffering"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewImportBackupOfferingParams(true, "description", "externalid", "name", "zoneid") + r, err := client.Backup.ImportBackupOffering(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("ImportBackupOffering", testimportBackupOffering) + + testlistBackupOfferings := func(t *testing.T) { + if _, ok := response["listBackupOfferings"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewListBackupOfferingsParams() + _, err := client.Backup.ListBackupOfferings(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListBackupOfferings", testlistBackupOfferings) + + testlistBackupProviderOfferings := func(t *testing.T) { + if _, ok := response["listBackupProviderOfferings"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewListBackupProviderOfferingsParams("zoneid") + _, err := client.Backup.ListBackupProviderOfferings(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListBackupProviderOfferings", testlistBackupProviderOfferings) + + testlistBackupProviders := func(t *testing.T) { + if _, ok := response["listBackupProviders"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewListBackupProvidersParams() + _, err := client.Backup.ListBackupProviders(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListBackupProviders", testlistBackupProviders) + + testlistBackupRepositories := func(t *testing.T) { + if _, ok := response["listBackupRepositories"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewListBackupRepositoriesParams() + _, err := client.Backup.ListBackupRepositories(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListBackupRepositories", testlistBackupRepositories) + + testlistBackupSchedule := func(t *testing.T) { + if _, ok := response["listBackupSchedule"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewListBackupScheduleParams("virtualmachineid") + _, err := client.Backup.ListBackupSchedule(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListBackupSchedule", testlistBackupSchedule) + + testlistBackups := func(t *testing.T) { + if _, ok := response["listBackups"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewListBackupsParams() + _, err := client.Backup.ListBackups(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListBackups", testlistBackups) + + testrestoreBackup := func(t *testing.T) { + if _, ok := response["restoreBackup"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewRestoreBackupParams("id") + _, err := client.Backup.RestoreBackup(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("RestoreBackup", testrestoreBackup) + + testupdateBackupOffering := func(t *testing.T) { + if _, ok := response["updateBackupOffering"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewUpdateBackupOfferingParams("id") + r, err := client.Backup.UpdateBackupOffering(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UpdateBackupOffering", testupdateBackupOffering) + + testupdateBackupSchedule := func(t *testing.T) { + if _, ok := response["updateBackupSchedule"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewUpdateBackupScheduleParams("intervaltype", "schedule", "timezone", "virtualmachineid") + r, err := client.Backup.UpdateBackupSchedule(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UpdateBackupSchedule", testupdateBackupSchedule) + +} diff --git a/test/VirtualMachineService_test.go b/test/VirtualMachineService_test.go index 9793e9c5..9721ff26 100644 --- a/test/VirtualMachineService_test.go +++ b/test/VirtualMachineService_test.go @@ -494,4 +494,28 @@ func TestVirtualMachineService(t *testing.T) { } t.Run("DeleteVMSchedule", testdeleteVMSchedule) + testassignVirtualMachineToBackupOffering := func(t *testing.T) { + if _, ok := response["assignVirtualMachineToBackupOffering"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.VirtualMachine.NewAssignVirtualMachineToBackupOfferingParams("backupofferingid", "virtualmachineid") + _, err := client.VirtualMachine.AssignVirtualMachineToBackupOffering(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("AssignVirtualMachineToBackupOffering", testassignVirtualMachineToBackupOffering) + + testremoveVirtualMachineFromBackupOffering := func(t *testing.T) { + if _, ok := response["removeVirtualMachineFromBackupOffering"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.VirtualMachine.NewRemoveVirtualMachineFromBackupOfferingParams("virtualmachineid") + _, err := client.VirtualMachine.RemoveVirtualMachineFromBackupOffering(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("RemoveVirtualMachineFromBackupOffering", testremoveVirtualMachineFromBackupOffering) + } diff --git a/test/VolumeService_test.go b/test/VolumeService_test.go index 448eb1f9..d9197b07 100644 --- a/test/VolumeService_test.go +++ b/test/VolumeService_test.go @@ -365,4 +365,16 @@ func TestVolumeService(t *testing.T) { } t.Run("AssignVolume", testassignVolume) + testrestoreVolumeFromBackupAndAttachToVM := func(t *testing.T) { + if _, ok := response["restoreVolumeFromBackupAndAttachToVM"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Volume.NewRestoreVolumeFromBackupAndAttachToVMParams("backupid", "virtualmachineid", "volumeid") + _, err := client.Volume.RestoreVolumeFromBackupAndAttachToVM(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("RestoreVolumeFromBackupAndAttachToVM", testrestoreVolumeFromBackupAndAttachToVM) + }